REST Resource: projects.databases.indexes

资源：索引

索引定义。

JSON 表示法 
{
  "name": string,
  "collectionId": string,
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
字段
name

string

索引的资源名称。仅限输出。
collectionId

string

此索引适用的集合 ID。必填。
fields[]

object (IndexField)

要编入索引的字段。
state

enum (State)

索引的状态。仅限输出。

IndexField

索引的字段。

JSON 表示法 
{
  "fieldPath": string,
  "mode": enum (Mode)
}
字段
fieldPath

string

字段的路径。必须符合 [google.firestore.v1beta1.Document.fields][fields] 所述的字段路径规范。特殊字段路径 __name__ 可以单独使用，也可以放在路径末尾。__type__ 只能在路径末尾使用。
mode

enum (Mode)

字段的模式。

模式

模式决定了字段的索引方式。

枚举
MODE_UNSPECIFIED 未指定模式。
ASCENDING 字段的值已编入索引，以便支持按升序排序，还可以通过 <、>、<=、>= 和 = 进行查询。
DESCENDING 字段的值会编入索引，以便支持按降序排序，并且还可以按 <、>、<=、>= 和 = 进行查询。
ARRAY_CONTAINS 该字段的数组值会编入索引，以便使用 ARRAY_CONTAINS 查询支持成员资格。

状态

索引的状态。在创建索引期间，索引将处于 CREATING 状态。如果成功创建索引，它会转换为 READY 状态。如果无法创建索引，它会转换为 ERROR 状态。

枚举
STATE_UNSPECIFIED 未指定状态。
CREATING 正在创建索引。有一项长期运行的索引有效操作。索引会在写入文档时更新。可能存在某些索引数据。
READY 索引已准备就绪，可供使用。索引会在写入文档时更新。索引由其适用的所有存储文档完全填充。
ERROR 正在创建索引，但出了点问题。没有针对索引的有效长时间运行的操作，最近完成的长时间运行的操作失败。在写入文档时，索引不会更新。可能存在某些索引数据。

方法

create

 创建指定的索引。

delete

 删除索引。

get

 获取索引。

list

 列出与指定过滤条件匹配的索引。