REST Resource: projects.databases.indexes

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

Định nghĩa chỉ mục.

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

string

Tên tài nguyên của chỉ mục. Chỉ có đầu ra.
collectionId

string

Mã bộ sưu tập áp dụng chỉ mục này. Bắt buộc.
fields[]

object (IndexField)

Các trường cần lập chỉ mục.
state

enum (State)

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

IndexField

Một trường của chỉ mục.

Biểu diễn dưới dạng JSON 
{
  "fieldPath": string,
  "mode": enum (Mode)
}
Trường
fieldPath

string

Đường dẫn của trường. Phải khớp với thông số kỹ thuật của đường dẫn trường được mô tả trong [google.firestore.v1beta1.Document.fields][fields]. Đường dẫn trường đặc biệt __name__ có thể được sử dụng độc lập hoặc ở cuối đường dẫn. Bạn chỉ có thể sử dụng __type__ ở cuối đường dẫn.
mode

enum (Mode)

Chế độ của trường.

Chế độ

Chế độ này xác định cách lập chỉ mục một trường.

Enum
MODE_UNSPECIFIED Chưa chỉ định chế độ.
ASCENDING Các giá trị của trường được lập chỉ mục để hỗ trợ sắp xếp theo trình tự tăng dần, đồng thời truy vấn theo <, >, <=, >= và =.
DESCENDING Các giá trị của trường được lập chỉ mục để hỗ trợ sắp xếp theo trình tự giảm dần, đồng thời truy vấn theo <, >, <=, >= và =.
ARRAY_CONTAINS Các giá trị mảng của trường được lập chỉ mục để hỗ trợ tư cách thành viên bằng cách sử dụng các truy vấn ARRAY_OPTIONSS.

Tiểu bang

Trạng thái của chỉ mục. Trong quá trình tạo chỉ mục, chỉ mục sẽ ở trạng thái CREATING. Nếu được tạo thành công, chỉ mục sẽ chuyển sang trạng thái READY. Nếu không thể tạo chỉ mục, chỉ mục sẽ chuyển sang trạng thái ERROR.

Enum
STATE_UNSPECIFIED Chưa xác định tiểu bang này.
CREATING Chỉ mục đang được tạo. Có một hoạt động hoạt động diễn ra trong thời gian dài cho chỉ mục. Chỉ mục được cập nhật khi soạn một tài liệu. Một số dữ liệu chỉ mục có thể tồn tại.
READY Chỉ mục đã sẵn sàng để sử dụng. Chỉ mục được cập nhật khi soạn một tài liệu. Chỉ mục được điền đầy đủ từ tất cả các tài liệu được lưu trữ mà chỉ mục áp dụng.
ERROR Chỉ mục đang được tạo, nhưng đã xảy ra lỗi. Không có hoạt động nào đang hoạt động trong thời gian dài cho chỉ mục và hoạt động chạy trong thời gian dài kết thúc gần đây nhất đều không thành công. Chỉ mục không được cập nhật khi soạn một tài liệu. Một số dữ liệu chỉ mục có thể tồn tại.

Phương thức

create

 Tạo chỉ mục được chỉ định.

delete

 Xoá chỉ mục.

get

 Lấy chỉ mục.

list

 Liệt kê các chỉ mục phù hợp với bộ lọc đã chỉ định.