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 được á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.

Trường chỉ mục

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ả theo [google.firestore.v1beta1.Document.fields][fields]. Đường dẫn trường đặc biệt __name__ có thể được chính đường dẫn đó sử dụng hoặc ở cuối một đường dẫ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 xác định chế độ.
ASCENDING Các giá trị của trường được lập chỉ mục để hỗ trợ sắp xếp trình tự theo thứ tự tăng dần và cũng có thể 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 trình tự theo thứ tự giảm dần và cũng có thể truy vấn theo <, >, <=, >= và =.
ARRAY_CONTAINS 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_CONTAINS.

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 Bạn chưa xác định trạng thái.
CREATING Chỉ mục đang được tạo. Chỉ mục có một hoạt động diễn ra trong thời gian dài. Chỉ mục được cập nhật khi viết tài liệu. Có thể tồn tại một số dữ liệu về chỉ mục.
READY Chỉ mục đã sẵn sàng để sử dụng. Chỉ mục được cập nhật khi viết tài liệu. Chỉ mục được điền đầy đủ từ mọi tài liệu được lưu trữ có áp dụng vào chỉ mục.
ERROR Đang tạo chỉ mục nhưng đã xảy ra lỗi. Không có hoạt động dài hạn nào đang hoạt động cho chỉ mục và thao tác chạy trong thời gian dài được hoàn thành gần đây nhất cũng không thành công. Chỉ mục không được cập nhật khi viết tài liệu. Có thể tồn tại một số dữ liệu về chỉ mục.

Phương thức

create

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

delete

 Xoá một chỉ mục.

get

 Lấy một chỉ mục.

list

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