Method: projects.databases.documents.batchWrite

ใช้ชุดการดำเนินการเขียน

เมธอด document.batchWrite ไม่ได้ใช้การดำเนินการเขียนแบบอะตอมและไม่สามารถนำไปใช้ตามลำดับได้ เมธอดไม่อนุญาตให้มีการเขียนมากกว่า 1 รายการต่อเอกสาร การเขียนแต่ละรายการสำเร็จหรือล้มเหลวโดยแยกกัน ดูสถานะความสำเร็จของการเขียนแต่ละรายการได้ที่ BatchWriteResponse

หากต้องการใช้ชุดการเขียนแบบอะตอม ให้ใช้ documents.commit แทน

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
database

string

ต้องระบุ ชื่อฐานข้อมูล ในรูปแบบ: projects/{projectId}/databases/{databaseId}

เนื้อหาของคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "writes": [
    {
      object (Write)
    }
  ],
  "labels": {
    string: string,
    ...
  }
}
ช่อง
writes[]

object (Write)

การเขียนที่จะใช้

วิธีการนี้ไม่ได้ใช้การเขียนแบบอะตอมและไม่รับประกันลำดับ การเขียนแต่ละรายการสำเร็จหรือล้มเหลวโดยแยกกัน คุณไม่สามารถเขียนลงในเอกสารเดียวกันเกิน 1 ครั้งต่อคำขอ
labels

map (key: string, value: string)

ป้ายกำกับที่เกี่ยวข้องกับการเขียนกลุ่มนี้

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่าง: { "name": "wrench", "mass": "1.3kg", "count": "3" }

เนื้อหาการตอบกลับ

คำตอบจาก Firestore.BatchWrite

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "status": [
    {
      object (Status)
    }
  ]
}
ช่อง
writeResults[]

object (WriteResult)

ผลของการใช้การเขียน

ผลการเขียน i นี้สอดคล้องกับการเขียน i-th ในคำขอ
status[]

object (Status)

สถานะของการใช้การเขียน

สถานะการเขียน i นี้สอดคล้องกับการเขียน i-th ในคำขอ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์