Method: projects.databases.documents.batchWrite

Áp dụng một loạt thao tác ghi.

Phương thức documents.batchWrite không áp dụng các thao tác ghi nguyên tử và có thể áp dụng chúng không đúng thứ tự. Phương thức không cho phép nhiều lần ghi trên mỗi tài liệu. Mỗi lần ghi thành công hoặc không thành công một cách độc lập. Xem BatchWriteResponse để biết trạng thái thành công của mỗi lần ghi.

Nếu bạn yêu cầu một tập hợp lượt ghi được áp dụng tỷ lệ, hãy sử dụng documents.commit.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
database

string

Bắt buộc. Tên cơ sở dữ liệu. Theo định dạng: projects/{projectId}/databases/{databaseId}.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "writes": [
    {
      object (Write)
    }
  ],
  "labels": {
    string: string,
    ...
  }
}
Trường
writes[]

object (Write)

Ghi để áp dụng.

Phương thức không áp dụng chức năng ghi nguyên tử và không đảm bảo thứ tự. Mỗi lần ghi thành công hoặc không thành công một cách độc lập. Bạn không thể ghi vào cùng một tài liệu nhiều lần cho mỗi yêu cầu.
labels

map (key: string, value: string)

Các nhãn được liên kết với lượt ghi theo lô này.

Đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Nội dung phản hồi

Phản hồi của Firestore.BatchWrite.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "status": [
    {
      object (Status)
    }
  ]
}
Trường
writeResults[]

object (WriteResult)

Kết quả của việc áp dụng các lượt ghi.

Kết quả ghi thứ i này tương ứng với lượt ghi thứ i trong yêu cầu.
status[]

object (Status)

Trạng thái áp dụng các lượt ghi.

Trạng thái ghi thứ i này tương ứng với trạng thái ghi thứ i trong yêu cầu.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau đây:

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

Để biết thêm thông tin, hãy xem bài viết Tổng quan về hoạt động xác thực.