Method: projects.databases.documents.listDocuments

列出文档。

HTTP 请求

GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents}/{collectionId}

网址采用 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)（即“祖鲁时”）格式的时间戳，采用纳秒级精度，最多包含九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

请求正文

请求正文必须为空。

响应正文

如果成功，则响应正文包含一个 ListDocumentsResponse 实例。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。