Method: projects.databases.documents.list
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
HTTP请求
GET https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
URL 使用gRPC 转码语法。
路径参数
参数 |
---|
parent | string 必需的。父资源名称。格式为: projects/{projectId}/databases/{databaseId}/documents 或projects/{projectId}/databases/{databaseId}/documents/{document_path} 。 例如: projects/my-project/databases/my-database/documents 或projects/my-project/databases/my-database/documents/chatrooms/my-chatroom |
collectionId | string 选修的。要列出的集合 ID,相对于parent 。 例如: chatrooms 或messages 。 这是可选的,如果未提供,Firestore 将列出所提供的parent 下所有集合中的文档。 |
查询参数
参数 |
---|
pageSize | integer 选修的。单个响应中返回的最大文档数。 Firestore 返回的值可能会少于此值。 |
pageToken | string 选修的。从先前的documents.list 响应接收到的页面令牌。 提供此信息以检索后续页面。分页时,所有其他参数( pageSize 除外)必须与生成页面令牌的请求中设置的值匹配。 |
orderBy | string 选修的。要返回的文档的可选排序。 例如: priority desc, __name__ desc 。 这反映了 Firestore 查询中使用的ORDER BY ,但采用字符串表示形式。如果不存在,文档将根据__name__ ASC 排序。 |
mask | object ( DocumentMask ) 选修的。要返回的字段。如果未设置,则返回所有字段。 如果文档具有此掩码中不存在的字段,则该字段将不会在响应中返回。 |
showMissing | boolean 如果列表应显示缺少的文档。 如果文档不存在,则该文档缺失,但其下面嵌套有子文档。如果为 true,则此类丢失的文档将带有键返回,但不会设置字段、 createTime 或updateTime 。 带有showMissing 请求可能不会指定where 或orderBy 。 |
联合参数consistency_selector 。此事务的一致性模式。如果不设置,默认为强一致性。 consistency_selector 只能是以下之一: |
transaction | string ( bytes format) 将读取作为已活动事务的一部分执行。 Base64 编码的字符串。 |
readTime | string ( Timestamp format) 在规定的时间执行读取。 这必须是过去一小时内的微秒精度时间戳,或者如果启用了时间点恢复,则还可以是过去 7 天内的整分钟时间戳。 RFC3339 UTC“Zulu”格式的时间戳,具有纳秒分辨率和最多九个小数位。示例: "2014-10-02T15:01:23Z" 和"2014-10-02T15:01:23.045123456Z" 。 |
授权范围
需要以下 OAuth 范围之一:
-
https://www.googleapis.com/auth/datastore
-
https://www.googleapis.com/auth/cloud-platform
有关详细信息,请参阅身份验证概述。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2023-12-01。
[{
"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":"其他"
}]