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" tương ứng. Nhóm này đại diện cho tất cả các bộ sưu tập trong cơ sở dữ liệu có cùng mã nhận dạng.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}
Trường
name

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 một đườ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.
indexConfig

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.
ttlConfig

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.

Cấu hình chỉ mục

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

Biểu diễn dưới dạng JSON 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
Trường
indexes[]

object (Index)

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

boolean

Chỉ có đầu ra. Nếu đúng, cấu hình chỉ mục của Field sẽ đượ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.
ancestorField

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).
reverting

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.

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 bật 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 không điền vào trường này sẽ vô hiệu hoá thời hạn đối với từng chứng từ.

Biểu diễn dưới dạng JSON 
{
  "state": enum (State)
}
Trường
state

enum (State)

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

Tiểu bang

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 chưa được xác định hoặc không xác định.
CREATING TTL đang được áp dụng. Có một hoạt động diễn ra trong thời gian dài để theo dõi 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 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 viết sẽ tiếp tục áp dụng TTL. LRO được trả về khi cố gắng bật TTL gần đây nhất cho Field này không thành công. Có thể có thêm thông tin chi tiết.

Phương thức

get

 Lấy siêu dữ liệu và cấu hình cho một Trường.

list

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

patch

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