Method: projects.databases.documents.batchWrite

تطبيق مجموعة من عمليات الكتابة.

لا تطبق طريقة Document.batchWrite عمليات الكتابة بشكل كامل ويمكن أن تطبقها بدون ترتيب. لا تسمح الطريقة بأكثر من كتابة واحدة لكل مستند. وتنجح كل عملية كتابة أو تفشل بشكل مستقل. اطّلِع على BatchWriteResponse لمعرفة حالة نجاح كل عملية كتابة.

إذا كنت تتطلّب مجموعة من عمليات الكتابة المطبَّقة على أجزاء شاملة، استخدِم documents.commit بدلاً من ذلك.

طلب HTTP

POST https://firestore.googleapis.com/v1beta1/{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-th في الطلب.
status[]

object (Status)

حالة تطبيق عمليات الكتابة.

تتجاوب حالة كتابة i-th هذه مع كتابة i-th في الطلب.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.