REST Resource: projects.databases.collectionGroups.fields

Tài nguyên: Trường

Đại diện cho một trường duy nhất trong cơ sở dữ liệu.

Các trường được nhóm theo "Nhóm bộ sưu tập" của chúng, đại diện cho tất cả các bộ sưu tập trong cơ sở dữ liệu có cùng id.

Biểu diễn JSON
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}
Lĩnh vực
name

string

Yêu cầu. Tên trường có dạng projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Đường dẫn trường có thể là 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 đường dẫn trường đặc biệt. Trường đặc biệt hợp lệ duy nhất là * , đại diện cho bất kỳ trường nào.

Đường dẫn trường có thể được trích dẫn bằng cách sử 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ư bất kỳ ký tự tượng trưng ascii nào.

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

Field đặc biệt chứa cài đặt lập chỉ mục mặc định cho tất cả các trường. Tên tài nguyên của trường này là: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* Các 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.

indexConfig

object ( IndexConfig )

Cấu hình chỉ mục cho trường này. Nếu không được đặt, việc lập chỉ mục trường sẽ hoàn nguyên về cấu hình được xác định bởi ancestorField . Để xóa rõ ràng tất cả các chỉ mục cho trường này, hãy chỉ định cấu hình chỉ mục với danh sách chỉ mục trống.

ttlConfig

object ( TtlConfig )

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

Cấu hình chỉ mục

Cấu hình chỉ mục cho trường này.

Biểu diễn JSON
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
Lĩnh vực
indexes[]

object ( Index )

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

usesAncestorConfig

boolean

Chỉ đầu ra. Khi đúng, cấu hình chỉ mục của Field được đặt từ cấu hình được chỉ định bởi ancestorField . Khi sai, cấu hình chỉ mục của Field được xác định rõ ràng.

ancestorField

string

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

reverting

boolean

Chỉ xuất ra Khi đúng, cấu hình chỉ mục của Field đang trong quá trình hoàn nguyên. 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 được chỉ định bởi ancestorField , tại thời điểm đó, usesAncestorConfig sẽ là truereverting sẽ là false .

TtlConfig

Cấu hình TTL (thời gian tồn tại) cho các tài liệu đã đặt Field này.

Việc lưu trữ giá trị dấu thời gian vào trường hỗ trợ TTL sẽ được coi là thời gian hết hạn tuyệt đối của tài liệu. Giá trị dấu thời gian trong quá khứ cho biết tài liệu đủ điều kiện hết hạn ngay lập tức. Việc sử dụng bất kỳ loại dữ liệu nào khác hoặc bỏ trống trường này sẽ vô hiệu hóa thời hạn hết hạn cho từng tài liệu.

Biểu diễn JSON
{
  "state": enum (State)
}
Lĩnh vực
state

enum ( State )

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

Tình trạng

Trạng thái áp dụng cấu hình TTL cho tất cả tài liệu.

Enum
STATE_UNSPECIFIED Trạng thái không xác định hoặc không xác định.
CREATING TTL đang được áp dụng. Có một hoạt động kéo dài đang hoạt động để theo dõi sự thay đổi. Các tài liệu mới viết sẽ được áp dụng TTL theo yêu cầu. TTL được yêu cầu trên các tài liệu hiện có vẫn đang được xử lý. Khi TTL trên tất cả các tài liệu hiện có đã được xử lý, trạng thái sẽ chuyển sang 'HOẠT ĐỘNG'.
ACTIVE TTL đang hoạt động cho tất cả các tài liệu.
NEEDS_REPAIR Không thể bật cấu hình TTL cho tất cả tài liệu hiện có. Các tài liệu mới được viết sẽ tiếp tục được áp dụng TTL. LRO trả về khi lần thử bật TTL cho Field này lần cuối không thành công và có thể có thêm chi tiết.

phương pháp

get

Nhận siêu dữ liệu và cấu hình cho Trường.

list

Liệt kê cấu hình trường và siêu dữ liệu cho cơ sở dữ liệu này.

patch

Cập nhật cấu hình trường.