Method: projects.databases.documents.batchGet

एक से ज़्यादा दस्तावेज़ मिलते हैं.

इस बात की कोई गारंटी नहीं है कि इस तरीके से लौटाए गए दस्तावेज़ों को उसी क्रम में वापस किया जाएगा जिस क्रम में उन्हें मांगा गया था.

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

POST https://firestore.googleapis.com/v1/{database=projects/*/databases/*}/documents:batchGet

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

पाथ पैरामीटर

पैरामीटर
database

string

ज़रूरी है. डेटाबेस का नाम. फ़ॉर्मैट: projects/{projectId}/databases/{databaseId}.

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

अनुरोध के मुख्य हिस्से में, यहां दिए गए स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "documents": [
    string
  ],
  "mask": {
    object (DocumentMask)
  },

  // Union field consistency_selector can be only one of the following:
  "transaction": string,
  "newTransaction": {
    object (TransactionOptions)
  },
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
फ़ील्ड
documents[]

string

वापस पाने के लिए दस्तावेज़ों के नाम. फ़ॉर्मैट: projects/{projectId}/databases/{databaseId}/documents/{document_path}. अगर कोई दस्तावेज़ दिए गए database का चाइल्ड रिसॉर्स नहीं है, तो अनुरोध स्वीकार नहीं किया जाएगा. डुप्लीकेट नाम हटा दिए जाएंगे.
mask

object (DocumentMask)

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

अगर किसी दस्तावेज़ में ऐसा फ़ील्ड है जो इस मास्क में मौजूद नहीं है, तो वह फ़ील्ड जवाब में नहीं लौटाया जाएगा.
यूनियन फ़ील्ड consistency_selector. इस लेन-देन के लिए कंसिस्टेंसी मोड. इस नीति को सेट न करने पर, डिफ़ॉल्ट रूप से एक जैसा अनुभव मिलता है. consistency_selector इनमें से सिर्फ़ एक हो सकता है:
transaction

string (bytes format)

लेन-देन के दस्तावेज़ों को पढ़ता है.

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

object (TransactionOptions)

नया लेन-देन शुरू करता है और दस्तावेज़ों को पढ़ता है. डिफ़ॉल्ट रूप से, रीड-ओनली लेन-देन होता है. नया लेन-देन आईडी, स्ट्रीम में पहले जवाब के तौर पर दिखाया जाएगा.
readTime

string (Timestamp format)

दस्तावेज़ों को ठीक उसी तरह पढ़ता है जिस तरह वे दिए गए समय पर मौजूद थे.

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

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

जवाब का लेख

Firestore.BatchGetDocuments के लिए स्ट्रीम किया गया जवाब.

अगर इंडेक्सिंग सही से हाे जाती है, ताे जवाब के लेख में नीचे दिए गए स्ट्रक्चर का डेटा शामिल होता है.

JSON के काेड में दिखाना 
{
  "transaction": string,
  "readTime": string,

  // Union field result can be only one of the following:
  "found": {
    object (Document)
  },
  "missing": string
  // End of list of possible types for union field result.
}
फ़ील्ड
transaction

string (bytes format)

इस अनुरोध के तहत शुरू किया गया लेन-देन. सिर्फ़ पहले जवाब में सेट किया जाएगा. ऐसा सिर्फ़ तब होगा, जब अनुरोध में BatchGetDocumentsRequest.new_transaction को सेट किया गया हो.

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

string (Timestamp format)

दस्तावेज़ को पढ़े जाने का समय. ऐसा हो सकता है कि यह संख्या एक ही तरीके से बढ़ रही हो. ऐसे में, इस मामले में इस बात की गारंटी है कि नतीजे दिखाने वाली स्ट्रीम में मौजूद पिछले दस्तावेज़ में, इसके पढ़े जाने के समय और इस अवधि के बीच कोई बदलाव नहीं होगा.

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

object (Document)

अनुरोध किया गया दस्तावेज़.
missing

string

दस्तावेज़ का वह नाम जिसका अनुरोध किया गया था, लेकिन वह मौजूद नहीं है. फ़ॉर्मैट: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

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

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

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

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