Method: projects.databases.documents.batchWrite

लेखन संक्रियाओं का एक बैच लागू करता है.

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

अगर आपको लिखने के अपने तरीके से लागू किए गए सेट की ज़रूरत है, तो इसके बजाय documents.commit का इस्तेमाल करें.

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

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

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

पाथ पैरामीटर

पैरामीटर
database

string

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

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

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

JSON के काेड में दिखाना 
{
  "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 का जवाब.

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

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

object (WriteResult)

लिखे गए शब्दों को लागू करने का नतीजा.

लिखने का यह नतीजा, अनुरोध में किए गए लिखने के नतीजे से मेल खाता है.
status[]

object (Status)

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

राइटिंग का यह स्टेटस, अनुरोध के राइट यानी अनुरोध के राइट से जुड़ा होता है.

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

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

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

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