Method: projects.databases.documents.batchWrite

Menerapkan sejumlah operasi tulis.

Metode document.batchWrite tidak menerapkan operasi penulisan secara atom dan dapat menerapkannya secara tidak berurutan. Metode tidak mengizinkan lebih dari satu penulisan per dokumen. Setiap penulisan berhasil atau gagal secara independen. Lihat BatchWriteResponse untuk mengetahui status keberhasilan setiap penulisan.

Jika Anda memerlukan serangkaian penulisan yang diterapkan secara atom, gunakan documents.commit sebagai gantinya.

permintaan HTTP

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

URL menggunakan sintaks Transcoding gRPC .

Parameter jalur

Parameter
database

string

Diperlukan. Nama basis data. Dalam format: projects/{projectId}/databases/{databaseId} .

Permintaan tubuh

Badan permintaan berisi data dengan struktur berikut:

Representasi JSON
{
  "writes": [
    {
      object (Write)
    }
  ],
  "labels": {
    string: string,
    ...
  }
}
bidang
writes[]

object ( Write )

Tulisan untuk melamar.

Metode tidak berlaku penulisan secara atom dan tidak menjamin pemesanan. Setiap penulisan berhasil atau gagal secara independen. Anda tidak dapat menulis ke dokumen yang sama lebih dari satu kali per permintaan.

labels

map (key: string, value: string)

Label yang terkait dengan batch ini ditulis.

Sebuah objek yang berisi daftar "key": value . Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

Badan respons

Tanggapan dari Firestore.BatchWrite .

Jika berhasil, isi respons berisi data dengan struktur berikut:

Representasi JSON
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "status": [
    {
      object (Status)
    }
  ]
}
bidang
writeResults[]

object ( WriteResult )

Hasil penerapan tulisan.

Hasil penulisan ke-i ini sesuai dengan penulisan ke-i dalam permintaan.

status[]

object ( Status )

Status penerapan tulisan.

Status penulisan ke-i ini sesuai dengan penulisan ke-i dalam permintaan.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi lebih lanjut, lihat Ikhtisar Otentikasi .