Method: projects.databases.documents.listDocuments

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

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

GET https://firestore.googleapis.com/v1beta1/{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)

दिए गए समय पर टेक्स्ट पढ़ें.

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

आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "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

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