REST Resource: projects.databases.collectionGroups.indexes

Tài nguyên: Chỉ mục

Chỉ mục trên Cloud Firestore cho phép thực hiện các truy vấn đơn giản và phức tạp dựa trên các tài liệu trong cơ sở dữ liệu.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "queryScope": enum (QueryScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Trường
name

string

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

enum (QueryScope)

Các chỉ mục có phạm vi truy vấn tập hợp được chỉ định sẽ cho phép truy vấn tập hợp là 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ã nhận dạng tập hợp.

Các chỉ mục có phạm vi truy vấn nhóm tập hợp được chỉ định cho phép truy vấn đối với tất cả các tập hợp 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ã nhận dạng tập hợp với chỉ mục này.
fields[]

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 theo cùng hướng với trường cuối cùng được xác định. Nếu trường cuối cùng trong một chỉ mục tổng hợp không có hướng, __name__ sẽ được sắp xếp theo thứ tự TĂNG CƯỜNG (trừ phi có chỉ định rõ ràng).

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

enum (State)

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

Phương thức

create

 Tạo chỉ mục tổng hợp.

delete

 Xóa chỉ mục tổng hợp.

get

 Lấy chỉ mục tổng hợp.

list

 Liệt kê các chỉ mục tổng hợp.