Method: projects.databases.documents.batchWrite

Bir yazma işlemi grubu uygular.

Docs.batchWrite yöntemi, yazma işlemlerini atomik olarak uygulamaz ve bunları sırasız şekilde uygulayabilir. Yöntem, doküman başına birden fazla yazmaya izin vermiyor. Her yazma işlemi bağımsız olarak başarılı veya başarısız olur. Her yazma işleminin başarı durumunu görmek için BatchWriteResponse inceleyin.

Atom olarak uygulanmış bir yazma grubuna ihtiyacınız varsa bunun yerine documents.commit kullanın.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
database

string

Zorunlu. Veritabanı adı. Belirtilen biçimde: projects/{projectId}/databases/{databaseId}.

İstek içeriği

İstek gövdesi, aşağıdaki yapıya sahip verileri içerir:

JSON gösterimi
{
  "writes": [
    {
      object (Write)
    }
  ],
  "labels": {
    string: string,
    ...
  }
}
Alanlar
writes[]

object (Write)

Uygulanacak yazma işlemleri.

Yöntem yazma işlemleri atomik olarak uygulanmaz ve sıralamayı garanti etmez. Her yazma işlemi bağımsız olarak başarılı veya başarısız olur. Aynı dokümana istek başına birden çok kez yazamazsınız.

labels

map (key: string, value: string)

Bu toplu yazma işlemiyle ilişkilendirilen etiketler.

"key": value çiftlerinin listesini içeren bir nesne. Örnek: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Yanıt gövdesi

Firestore.BatchWrite tarafından gönderilen yanıt.

Başarılı olursa yanıt gövdesi aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "status": [
    {
      object (Status)
    }
  ]
}
Alanlar
writeResults[]

object (WriteResult)

Yazma işlemlerinin uygulanmasının sonucu.

Bu i-'inci yazma sonucu, istekteki i. yazma işlemine karşılık gelir.

status[]

object (Status)

Yazma işlemlerinin uygulanma durumu.

Bu i-'inci yazma durumu, istekteki i. yazma durumuna karşılık gelir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış başlıklı makaleye bakın.