资源:索引
索引定义。
JSON 表示 |
---|
{ "name": string, "collectionId": string, "fields": [ { object ( |
领域 | |
---|---|
name | 索引的资源名称。仅输出。 |
collectionId | 该索引适用的集合 ID。必需的。 |
fields[] | 要索引的字段。 |
state | 索引的状态。仅输出。 |
索引字段
索引的一个字段。
JSON 表示 |
---|
{
"fieldPath": string,
"mode": enum ( |
领域 | |
---|---|
fieldPath | 田野的路径。必须匹配 [google.firestore.v1beta1.Document.fields][fields] 描述的字段路径规范。特殊字段路径 |
mode | 场的模式。 |
模式
模式决定字段的索引方式。
枚举 | |
---|---|
MODE_UNSPECIFIED | 模式未指定。 |
ASCENDING | 该字段的值被索引,以支持升序排序,也支持按 <、>、<=、>= 和 = 查询。 |
DESCENDING | 该字段的值被索引,以支持降序排序,也支持按 <、>、<=、>= 和 = 查询。 |
ARRAY_CONTAINS | 该字段的数组值已建立索引,以便支持使用 ARRAY_CONTAINS 查询的成员资格。 |
状态
索引的状态。在索引创建过程中,索引将处于CREATING
状态。如果索引创建成功,则会转入READY
状态。如果无法创建索引,则会转换为ERROR
状态。
枚举 | |
---|---|
STATE_UNSPECIFIED | 状态未指定。 |
CREATING | 正在创建索引。该索引有一个活跃的长期运行操作。写入文档时索引会更新。可能存在一些索引数据。 |
READY | 该索引已准备好可供使用。写入文档时索引会更新。该索引完全由它所适用的所有存储文档填充。 |
ERROR | 正在创建索引,但出了点问题。该索引没有活动的长时间运行操作,并且最近完成的长时间运行操作失败。写入文档时索引不会更新。可能存在一些索引数据。 |
方法 | |
---|---|
| 创建指定的索引。 |
| 删除索引。 |
| 获取索引。 |
| 列出与指定过滤器匹配的索引。 |