REST Resource: projects.databases.collectionGroups.indexes

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

Các chỉ mục của Cloud Firestore cho phép truy vấn đơn giản và phức tạp đối với các tài liệu trong cơ sở dữ liệu.

Biểu diễn JSON
{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Lĩnh vực
name

string

Chỉ đầu ra. Tên do máy chủ xác định cho chỉ mục này. Dạng tên này cho các chỉ mục tổng 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 bộ sưu tập được chỉ định cho phép truy vấn đối với bộ sưu tậ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 id 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 cho phép truy vấn đối với tất cả các bộ sưu tập có nguồn gốc 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 id bộ sưu tập với chỉ mục này.

apiScope

enum ( ApiScope )

Phạm vi API được chỉ mục này hỗ trợ.

fields[]

object ( IndexField )

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

Đối với các chỉ mục tổng hợp, điều này yêu cầu tối thiểu là 2 và tối đa là 100 trường. 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, nó sẽ được thêm tự động 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 chỉ mục tổng hợp không có tính định hướng thì __name__ sẽ được sắp xếp TĂNG CƯỜNG (trừ khi được chỉ định rõ ràng).

Đối với các chỉ mục trường đơn, đây sẽ luôn chính xác là 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ỉ đầu ra. Trạng thái phục vụ của chỉ mục.

phương pháp

create

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

delete

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

get

Nhận một chỉ số tổng hợp.

list

Liệt kê các chỉ số tổng hợp.