Menerapkan sekumpulan operasi tulis.
Metode document.batchWrite tidak menerapkan operasi tulis secara atomik 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 kumpulan operasi tulis yang diterapkan secara atomik, gunakan documents.commit
.
Permintaan HTTP
POST https://firestore.googleapis.com/v1beta1/{database=projects/*/databases/*}/documents:batchWrite
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
database |
Wajib. Nama database. Dalam format: |
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{
"writes": [
{
object ( |
Kolom | |
---|---|
writes[] |
Penulisan yang akan diterapkan. Metode tidak menerapkan penulisan secara atomik dan tidak menjamin pengurutan. Setiap penulisan berhasil atau gagal secara independen. Anda tidak dapat menulis ke dokumen yang sama lebih dari sekali per permintaan. |
labels |
Label yang terkait dengan batch operasi ini. Objek yang berisi daftar pasangan |
Isi respons
Respons dari Firestore.BatchWrite
.
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "writeResults": [ { object ( |
Kolom | |
---|---|
writeResults[] |
Hasil penerapan penulisan. Hasil penulisan i-th ini sesuai dengan penulisan i-th dalam permintaan. |
status[] |
Status penerapan operasi tulis. Status penulisan i-th 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 selengkapnya, lihat Ringkasan Autentikasi.