资源:索引
索引定义。
JSON 表示法 |
---|
{ "name": string, "collectionId": string, "fields": [ { object ( |
字段 | |
---|---|
name |
索引的资源名称。仅限输出。 |
collectionId |
此索引适用的集合 ID。必填。 |
fields[] |
要编入索引的字段。 |
state |
索引的状态。仅限输出。 |
IndexField
索引的字段。
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 |
正在创建索引,但出了点问题。索引没有正在进行的长时间运行的操作,并且最近完成的长时间运行的操作失败。写入文档时索引不会更新。可能存在一些索引数据。 |
方法 |
|
---|---|
|
创建指定的索引。 |
|
删除索引。 |
|
获取索引。 |
|
列出与指定过滤条件匹配的索引。 |