Method: projects.databases.documents.batchWrite

دسته ای از عملیات نوشتن را اعمال می کند.

روش document.batchWrite عملیات نوشتن را به صورت اتمی اعمال نمی کند و می تواند آنها را خارج از نظم اعمال کند. روش اجازه نمی دهد بیش از یک نوشتن در هر سند. هر نوشته به طور مستقل با موفقیت یا شکست مواجه می شود. برای وضعیت موفقیت هر نوشته به BatchWriteResponse مراجعه کنید.

اگر به مجموعه ای از نوشتن ها به صورت اتمی نیاز دارید، به جای آن از documents.commit استفاده کنید.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
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-ام با نوشتن i-ام در درخواست مطابقت دارد.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.