REST Resource: projects.databases.collectionGroups.indexes
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
资源:索引
借助 Cloud Firestore 索引,您可以对数据库中的文档执行简单和复杂的查询。
JSON 表示法 |
{
"name": string,
"queryScope": enum (QueryScope ),
"fields": [
{
object (IndexField )
}
],
"state": enum (State )
} |
字段 |
name |
string
仅供输出。服务器为此索引定义的名称。复合索引的此名称格式为:projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} 。对于单字段索引,此字段将为空。
|
queryScope |
enum (QueryScope )
如果索引指定了集合查询范围,则索引支持对作为特定文档的子项、在查询时指定且具有相同集合 ID 的集合进行查询。 如果索引指定了集合组查询范围,则索引允许查询来自特定文档、在查询时指定并且与此索引具有相同集合 ID 的所有集合。
|
fields[] |
object (IndexField )
此索引支持的字段。 对于复合索引,此字段始终为 2 个或更多字段。最后一个字段条目始终针对字段路径 __name__ 。如果在创建时未指定 __name__ 作为最后一个字段,系统将按照与定义的最后一个字段相同的方向自动添加该字段。如果复合索引中的最后一个字段没有方向性,则 __name__ 将按升序排列(除非明确指定)。 对于单字段索引,此字段始终只有一个条目,其字段路径等于关联字段的字段路径。
|
state |
enum (State )
仅供输出。索引的服务状态。
|
方法 |
|
创建复合索引。 |
|
删除复合索引。 |
|
获取复合索引。 |
|
列出复合索引。 |
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-04-12。
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"没有我需要的信息"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"太复杂/步骤太多"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"内容需要更新"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"翻译问题"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"示例/代码问题"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"其他"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"易于理解"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"解决了我的问题"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"其他"
}]