Method: projects.databases.documents.batchWrite

Toplu yazma işlemi uygular.

documents.batchWrite yöntemi, yazma işlemlerini atomik olarak uygulamaz ve bunları sıra dışı bir şekilde uygulayabilir. Yöntem, belge 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 göz atın.

Atomik olarak uygulanmış bir yazma grubu gerekiyorsa bunun yerine documents.commit kullanın.

HTTP isteği

POST https://firestore.googleapis.com/v1beta1/{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ı. Biçimi: projects/{projectId}/databases/{databaseId}.

İstek içeriği

İsteğin gövdesi, aşağıdaki yapıya sahip veriler içerir:

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

object (Write)

Uygulanacak yazmalar.

Yöntem, yazma işlemlerini atomik olarak uygulamaz 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 fazla kez yazamazsınız.

labels

map (key: string, value: string)

Bu toplu yazma işlemiyle ilişkili etiketler.

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

Yanıt gövdesi

Firestore.BatchWrite adlı kullanıcının yanıtı.

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

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

object (WriteResult)

Yazmalar uygulandığında elde edilen sonuç.

Bu yazma sonucu, istekteki son yazma işlemine karşılık gelir.

status[]

object (Status)

Yazmaların uygulanma durumu.

Bu yazma durumu, istekteki son yazma işlemine 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ış sayfasına göz atın.