REST Resource: projects.databases.collectionGroups.fields

{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}

string

Bắt buộc. 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.

object (IndexConfig)

Cấu hình chỉ mục cho trường này. Nếu bạn không đặt chính sách này, việc lập chỉ mục trường sẽ chuyển về cấu hình do ancestorField xác định. Để xoá tất cả chỉ mục cho trường này một cách rõ ràng, hãy chỉ định cấu hình chỉ mục có danh sách chỉ mục trống.

object (TtlConfig)

Cấu hình TTL cho Field này. Việc đặt hoặc huỷ đặt chính sách này sẽ bật hoặc tắt TTL cho các tài liệu có Field này.

{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}

object (Index)

Các chỉ mục được hỗ trợ cho trường này.

boolean

Chỉ có đầu ra. Nếu đúng, cấu hình chỉ mục của Field được đặt từ cấu hình do ancestorField chỉ định. Khi đặt là false, cấu hình chỉ mục của Field sẽ được xác định rõ ràng.

string

Chỉ có đầu ra. Chỉ định tên tài nguyên của Field mà từ đó cấu hình chỉ mục của trường này được đặt (khi usesAncestorConfig là true) hoặc từ đó sẽ được đặt nếu trường này không có cấu hình chỉ mục (khi usesAncestorConfig là false).

boolean

Chỉ đầu ra Khi đúng, cấu hình chỉ mục của Field đang trong quá trình bị huỷ bỏ. Sau khi hoàn tất, cấu hình chỉ mục sẽ chuyển sang trạng thái giống như trường do ancestorField chỉ định, khi đó usesAncestorConfig sẽ là true và reverting sẽ là false.

{
  "state": enum (State)
}

enum (State)

Chỉ có đầu ra. Trạng thái của cấu hình TTL.