Method: projects.databases.documents.list

दस्तावेज़ की सूची दिखाता है.

एचटीटीपी अनुरोध

GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ के पैरामीटर

पैरामीटर
parent

string

ज़रूरी है. पैरंट रिसॉर्स का नाम. फ़ॉर्मैट: projects/{projectId}/databases/{databaseId}/documents या projects/{projectId}/databases/{databaseId}/documents/{document_path}.

उदाहरण के लिए: projects/my-project/databases/my-database/documents या projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
collectionId

string

ज़रूरी नहीं. सूची में मौजूद, parent से जुड़ा कलेक्शन आईडी.

उदाहरण के लिए: chatrooms या messages.

ऐसा करना ज़रूरी नहीं है. अगर इसे उपलब्ध नहीं कराया जाता, तो Firestore दिए गए parent के तहत सभी कलेक्शन के दस्तावेज़ों की सूची बना देगा.

क्वेरी पैरामीटर

पैरामीटर
pageSize

integer

ज़रूरी नहीं. एक जवाब में लौटाए जाने वाले दस्तावेज़ों की ज़्यादा से ज़्यादा संख्या.

Firestore, इस वैल्यू से कम वैल्यू दिखा सकता है.
pageToken

string

ज़रूरी नहीं. documents.list के पिछले जवाब से मिला पेज टोकन.

बाद वाला पेज फिर से पाने के लिए यह विकल्प दें. पेज पर नंबर डालकर, pageSize को छोड़कर अन्य सभी पैरामीटर, पेज टोकन जनरेट करने वाले अनुरोध में सेट की गई वैल्यू से मैच होना चाहिए.
orderBy

string

ज़रूरी नहीं. लौटाए जाने वाले दस्तावेज़ों का वैकल्पिक क्रम.

उदाहरण के लिए: priority desc, __name__ desc.

यह Firestore क्वेरी में इस्तेमाल किए गए ORDER BY के डेटा की डुप्लीकेट कॉपी बनाता है, लेकिन स्ट्रिंग प्रज़ेंटेशन में करता है. मौजूद नहीं होने पर, दस्तावेज़ों का क्रम __name__ ASC के हिसाब से लगाया जाता है.
mask

object (DocumentMask)

ज़रूरी नहीं. लौटाए जाने वाले फ़ील्ड. अगर यह नीति सेट नहीं है, तो सभी फ़ील्ड दिखाता है.

अगर किसी दस्तावेज़ में ऐसा फ़ील्ड है जो इस मास्क में मौजूद नहीं है, तो जवाब में वह फ़ील्ड नहीं दिखेगा.
showMissing

boolean

क्या सूची में वे दस्तावेज़ दिखेंगे जो मौजूद नहीं हैं.

कोई दस्तावेज़ मौजूद न होने पर वह मौजूद नहीं होता है. हालांकि, उसके नीचे उप-दस्तावेज़ मौजूद होते हैं. सही होने पर, ऐसे दस्तावेज़ एक कुंजी के साथ दिए जाएंगे, लेकिन उनमें फ़ील्ड, createTime या updateTime सेट नहीं होगा.

showMissing से किए गए अनुरोधों में where या orderBy के बारे में जानकारी नहीं दी जा सकती.
यूनियन पैरामीटर consistency_selector. इस लेन-देन के लिए अनुकूलता मोड. अगर यह नीति सेट नहीं है, तो डिफ़ॉल्ट रूप से अच्छी कंसिस्टेंसी होती है. consistency_selector इनमें से सिर्फ़ एक हो सकती है:
transaction

string (bytes format)

पहले से चालू किसी लेन-देन के हिस्से के तौर पर रीड करें.

base64 कोड में बदली गई स्ट्रिंग.
readTime

string (Timestamp format)

दिए गए समय पर रीड ऐक्शन करें.

यह पिछले एक घंटे के अंदर का माइक्रोसेकंड का सटीक टाइमस्टैंप होना चाहिए. इसके अलावा, अगर पॉइंट-इन-टाइम रिकवरी चालू है, तो यह पिछले सात दिनों में पूरे मिनट का टाइमस्टैंप भी हो सकता है.

RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड का रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक हो सकते हैं. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य हिस्सा

कामयाब रहने पर, जवाब के मुख्य हिस्से में ListDocumentsResponse का एक इंस्टेंस शामिल किया जाता है.

अनुमति के दायरे

इनमें से किसी एक OAuth दायरों की ज़रूरत होती है:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.