Method: projects.databases.documents.batchWrite

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

Phương thức document.batchWrite không áp dụng cho các tác vụ ghi một cách tỉ mỉ và có thể áp dụng các tác vụ đó không đúng thứ tự. Phương thức không cho phép ghi nhiều hơn một lần cho mỗi tài liệu. Mỗi lượt ghi có thể thực hiện 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ượt ghi.

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

yêu cầu HTTP

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

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

Tham số đường dẫn

Thông số
database

string

Bắt buộc. Tên cơ sở dữ liệu. Ở đị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)

Các quyền cần ghi để áp dụng.

Phương thức không áp dụng cho việc ghi ở cấp độ nguyên tử và không đảm bảo thứ tự. Mỗi lượt ghi có thể thực hiện 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 thao tác ghi hàng loạt này.

Một đố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, 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 hoạt động ghi.

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

object (Status)

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

Trạng thái ghi thứ i này tương ứng với lần 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:

  • 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ề việc xác thực.