REST Resource: projects.databases.collectionGroups.indexes

资源：索引

借助 Cloud Firestore 索引，您可以对数据库中的文档执行简单和复杂的查询。

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

string

仅供输出。服务器为此索引定义的名称。复合索引的此名称格式为：projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id}。对于单字段索引，此字段将为空。
queryScope

enum (QueryScope)

如果索引指定了集合查询范围，则索引支持对作为特定文档的子项、在查询时指定且具有相同集合 ID 的集合进行查询。

如果索引指定了集合组查询范围，则索引允许查询来自特定文档、在查询时指定并且与此索引具有相同集合 ID 的所有集合。
apiScope

enum (ApiScope)

此索引支持的 API 范围。
fields[]

object (IndexField)

此索引支持的字段。

对于复合索引，这至少需要 2 个字段，最多 100 个字段。最后一个字段条目始终针对字段路径 __name__。如果在创建时未指定 __name__ 作为最后一个字段，系统将按照与定义的最后一个字段相同的方向自动添加该字段。如果复合索引中的最后一个字段没有方向性，则 __name__ 将按升序排列（除非明确指定）。

对于单字段索引，此字段始终只有一个条目，其字段路径等于关联字段的字段路径。
state

enum (State)

仅供输出。索引的服务状态。

方法

create

 创建复合索引。

delete

 删除复合索引。

get

 获取复合索引。

list

 列出复合索引。