套用批次寫入作業。
document.batchWrite 方法則會以不可分割的形式套用寫入作業,而且可能會隨機套用。這個方法規定每份文件只能寫入一次。每項寫入作業都會獨立成功或失敗。如要瞭解每次寫入的成功狀態,請參閱 BatchWriteResponse
。
如果需要一組以不可分割的形式套用的寫入作業,請改用 documents.commit
。
HTTP 要求
POST https://firestore.googleapis.com/v1/{database=projects/*/databases/*}/documents:batchWrite
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
database |
必要欄位。資料庫名稱。請採用下列格式: |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{
"writes": [
{
object ( |
欄位 | |
---|---|
writes[] |
要套用的寫入內容。 這個方法不會自動套用寫入作業,不保證會排序。每項寫入作業都會獨立成功或失敗。每項要求最多只能寫入同一份文件一次。 |
labels |
與這項批次寫入作業相關聯的標籤。 這個物件中包含 |
回應主體
Firestore.BatchWrite
的回應。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{ "writeResults": [ { object ( |
欄位 | |
---|---|
writeResults[] |
套用寫入的結果。 這個 i-th 寫入結果對應要求中的第 i 次寫入。 |
status[] |
套用寫入的狀態。 這個 i-th 寫入狀態對應至要求中的第 i 次寫入。 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
詳情請參閱驗證總覽。