Method: projects.databases.documents.batchWrite

लिखने की कार्रवाइयों के बैच को लागू किया जाता है.

Docs.batchWrite का तरीका, ऐटमली तौर पर लिखने की प्रोसेस को लागू नहीं करता है. साथ ही, उन्हें गलत क्रम में लागू किया जा सकता है. विधि प्रति दस्तावेज़ एक से ज़्यादा लिखने की अनुमति नहीं देती है. हर लेख अपने-आप काम करता है या नहीं. हर लेख की सफलता की स्थिति जानने के लिए, BatchWriteResponse देखें.

अगर आपको ऐटमिकल तौर पर लिखने का सेट चाहिए, तो documents.commit का इस्तेमाल करें.

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

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

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

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

पैरामीटर
database

string

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "writes": [
    {
      object (Write)
    }
  ],
  "labels": {
    string: string,
    ...
  }
}
फ़ील्ड
writes[]

object (Write)

लागू करने के लिए लेख.

मेथड, ऐटमली लिखने के लिए लागू नहीं होता और न ही यह गारंटी के साथ ऑर्डर देता है. हर लेख अपने-आप काम करता है या नहीं. एक ही दस्तावेज़ में हर अनुरोध के लिए, एक से ज़्यादा बार कॉन्टेंट नहीं लिखा जा सकता.
labels

map (key: string, value: string)

इस बैच में लिखने से जुड़े लेबल.

एक ऑब्जेक्ट, जिसमें "key": value पेयर की सूची है. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

जवाब का मुख्य भाग

Firestore.BatchWrite से मिला जवाब.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

जेएसओएन के काेड में दिखाना 
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "status": [
    {
      object (Status)
    }
  ]
}
फ़ील्ड
writeResults[]

object (WriteResult)

लेख लागू करने का नतीजा.

i-वां लिखने का यह नतीजा, अनुरोध में मौजूद i-th राइट के हिसाब से होता है.
status[]

object (Status)

लेख लागू करने की स्थिति.

i-th लिखने की यह स्थिति, अनुरोध में मौजूद i-th राइट के हिसाब से होती है.

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

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

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

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