REST Resource: projects.databases.collectionGroups.indexes

{
  "name": string,
  "queryScope": enum (QueryScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}

string

Chỉ có đầu ra. Tên do máy chủ xác định cho chỉ mục này. Tên này cho chỉ mục tổng hợp sẽ là: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} Đối với chỉ mục trường đơn, trường này sẽ trống.

enum (QueryScope)

Các chỉ mục có phạm vi truy vấn bộ sưu tập được chỉ định sẽ cho phép truy vấn đối với một tập hợp là phần tử con của một tài liệu cụ thể, được chỉ định tại thời điểm truy vấn và có cùng mã bộ sưu tập.

Các chỉ mục có phạm vi truy vấn nhóm bộ sưu tập được chỉ định sẽ cho phép truy vấn đối với tất cả các bộ sưu tập là bắt nguồn từ một tài liệu cụ thể, được chỉ định tại thời điểm truy vấn và có cùng mã bộ sưu tập với chỉ mục này.

object (IndexField)

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

Đối với chỉ mục tổng hợp, đây luôn là 2 trường trở lên. Mục nhập trường cuối cùng luôn dành cho đường dẫn trường __name__. Nếu khi tạo, __name__ không được chỉ định làm trường cuối cùng, thì trường này sẽ tự động được thêm vào theo cùng hướng với trường được xác định gần đây nhất. Nếu trường cuối cùng trong chỉ mục tổng hợp không mang tính định hướng, thì __name__ sẽ được sắp xếp theo thứ tự ASCENDING (trừ khi được chỉ định rõ ràng).

Đối với các chỉ mục trường đơn, đây sẽ luôn là một mục nhập có đường dẫn trường bằng với đường dẫn trường của trường được liên kết.

enum (State)

Chỉ có đầu ra. Trạng thái phân phát của chỉ mục.