获取多个文档。
不保证此方法返回的文档按照请求的顺序返回。
HTTP请求
POST https://firestore.googleapis.com/v1beta1/{database=projects/*/databases/*}/documents:batchGet
URL 使用gRPC 转码语法。
路径参数
参数 | |
---|---|
database | 必需的。数据库名称。格式为: |
请求正文
请求正文包含具有以下结构的数据:
JSON 表示 |
---|
{ "documents": [ string ], "mask": { object ( |
领域 | |
---|---|
documents[] | 要检索的文档的名称。格式为: |
mask | 要返回的字段。如果未设置,则返回所有字段。 如果文档具有此掩码中不存在的字段,则该字段将不会在响应中返回。 |
联合字段consistency_selector 。此事务的一致性模式。如果不设置,默认为强一致性。 consistency_selector 只能是以下之一: | |
transaction | 读取事务中的文档。 Base64 编码的字符串。 |
newTransaction | 启动新事务并读取文档。默认为只读事务。新的事务 ID 将作为流中的第一个响应返回。 |
readTime | 按给定时间的原样读取文档。 这必须是过去一小时内的微秒精度时间戳,或者如果启用了时间点恢复,则还可以是过去 7 天内的整分钟时间戳。 RFC3339 UTC“Zulu”格式的时间戳,具有纳秒分辨率和最多九个小数位。示例: |
响应体
Firestore.BatchGetDocuments
的流式响应。
如果成功,响应正文包含具有以下结构的数据:
JSON 表示 |
---|
{ "transaction": string, "readTime": string, // Union field |
领域 | |
---|---|
transaction | 作为此请求的一部分启动的事务。仅在第一个响应中设置,并且仅当在请求中设置了 Base64 编码的字符串。 |
readTime | 阅读文档的时间。这可能是单调递增的,在这种情况下,保证结果流中的前一个文档在其 readTime 和本文档之间不会发生更改。 RFC3339 UTC“Zulu”格式的时间戳,具有纳秒分辨率和最多九个小数位。示例: |
联盟场result 。单一结果。如果服务器只是返回事务,则该值可以为空。 result 只能是以下之一: | |
found | 所要求的文件。 |
missing | 已请求但不存在的文档名称。格式为: |
授权范围
需要以下 OAuth 范围之一:
-
https://www.googleapis.com/auth/datastore
-
https://www.googleapis.com/auth/cloud-platform
有关详细信息,请参阅身份验证概述。