Method: projects.databases.documents.batchWrite

מחיל קבוצה של פעולות כתיבה.

שיטת document.batchWrite לא מחילה את פעולות הכתיבה באופן אטומי ויכולה להחיל אותן שלא לפי הסדר. השיטה לא מאפשרת כתיבה אחת לכל מסמך. כל כתיבה מצליחה או נכשלת בנפרד. בBatchWriteResponse ניתן לראות את סטטוס ההצלחה של כל כתיבה.

אם יש צורך בקבוצת כתבים שהוחלה באופן אטומי, צריך להשתמש במקום זאת ב-documents.commit.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של 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)

התוצאה של החלת הכתיבה.

תוצאת הכתיבה ה-i תואמת לכתיבה ה-i שבבקשה.
status[]

object (Status)

הסטטוס של החלת כתבי היד.

סטטוס הכתיבה ה-i-th תואם לכתיבה ה-i-th שבבקשה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

מידע נוסף זמין בסקירה הכללית על אימות.