Method: projects.databases.collectionGroups.fields.patch

Cập nhật một cấu hình trường. Hiện tại, nội dung cập nhật về trường chỉ áp dụng cho cấu hình chỉ mục trường duy nhất. Tuy nhiên, các lệnh gọi đến FirestoreAdmin.UpdateField phải cung cấp mặt nạ trường để tránh thay đổi bất kỳ cấu hình nào mà phương thức gọi không biết. Bạn phải chỉ định mặt nạ trường là: { paths: "indexConfig" }.

Lệnh gọi này trả về một google.longrunning.Operation có thể dùng để theo dõi trạng thái cập nhật trường. Siêu dữ liệu của thao tác sẽ là kiểu FieldOperationMetadata.

Để định cấu hình chế độ cài đặt trường mặc định cho cơ sở dữ liệu, hãy sử dụng Field đặc biệt có tên tài nguyên: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*.

yêu cầu HTTP

PATCH https://firestore.googleapis.com/v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}

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

Tham số đường dẫn

Thông số
field.name

string

Tên trường của biểu mẫu projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Đường dẫn trường có thể là một tên trường đơn giản, ví dụ: address hoặc đường dẫn đến các trường trong mapValue (ví dụ: address.city) hoặc một đường dẫn trường đặc biệt. Trường đặc biệt hợp lệ duy nhất là *, đại diện cho trường bất kỳ.

Bạn có thể trích dẫn các đường dẫn trường bằng cách dùng (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:*,., ``` (backtick),[,]`, cũng như các ký tự tượng trưng trong bảng mã ASCII.

Ví dụ: (Lưu ý: Nhận xét ở đây được viết theo cú pháp Markdown, do đó, có thêm một lớp dấu phẩy ngược để thể hiện khối mã) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, không phải bất kỳ trường nào.

Một Field đặc biệt chứa các chế độ cài đặt lập chỉ mục mặc định cho mọi trường. Tên tài nguyên của trường này là: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* Chỉ mục được xác định trên Field này sẽ được áp dụng cho tất cả các trường không có cấu hình chỉ mục Field riêng.

Tham số truy vấn

Thông số
updateMask

string (FieldMask format)

Một mặt nạ, so với trường. Nếu bạn chỉ định, chỉ cấu hình do trường này chỉ định mới được cập nhật trong trường.

Đây là danh sách các tên trường đủ điều kiện được phân tách bằng dấu phẩy. Ví dụ: "user.displayName,photo"

Nội dung yêu cầu

Phần nội dung yêu cầu chứa một thực thể của Field.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một thực thể của Operation.

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.