Method: projects.databases.documents.batchGet

获取多个文档。

不保证此方法返回的文档会按照请求的顺序返回。

HTTP 请求

POST https://firestore.googleapis.com/v1beta1/{database=projects/*/databases/*}/documents:batchGet

网址采用 gRPC 转码语法。

路径参数

参数
database

string

必需。数据库名称。格式为 projects/{projectId}/databases/{databaseId}。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "documents": [
    string
  ],
  "mask": {
    object (DocumentMask)
  },

  // Union field consistency_selector can be only one of the following:
  "transaction": string,
  "newTransaction": {
    object (TransactionOptions)
  },
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
字段
documents[]

string

要检索的文档的名称。格式为 projects/{projectId}/databases/{databaseId}/documents/{document_path}。如有任何文档不是给定 database 的子资源，请求将失败。重复的名称会被省略。
mask

object (DocumentMask)

要返回的字段。如果未设置，则返回所有字段。

如果文档的某个字段在此掩码中不存在，则不会在响应中返回该字段。
联合字段 consistency_selector。此事务的一致性模式。如果未设置，则默认为强一致性。consistency_selector 只能是下列其中一项：
transaction

string (bytes format)

读取事务中的文档。

使用 base64 编码的字符串。
newTransaction

object (TransactionOptions)

启动新事务并读取文档。默认为只读事务。新的交易 ID 将作为数据流中的第一个响应返回。
readTime

string (Timestamp format)

以给定时间原样读取文档。

该时间戳必须是过去 1 小时内精确到微秒的时间戳，或者如果启用了时间点恢复，也可以是过去 7 天内整分钟的时间戳。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

响应正文

Firestore.BatchGetDocuments 的流式传输响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "transaction": string,
  "readTime": string,

  // Union field result can be only one of the following:
  "found": {
    object (Document)
  },
  "missing": string
  // End of list of possible types for union field result.
}
字段
transaction

string (bytes format)

作为此请求的一部分启动的事务。仅在第一个响应中，且仅当请求中设置了 BatchGetDocumentsRequest.new_transaction 时才会设置。

使用 base64 编码的字符串。
readTime

string (Timestamp format)

文档的读取时间。该值可能会单调递增，在这种情况下，结果流中的先前文档可以保证在 readTime 与当前时间之间不发生变化。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
联合字段 result。单个结果。如果服务器仅返回事务，此字段可能为空。result 只能是下列其中一项：
found

object (Document)

所请求的文档。
missing

string

所请求的文档名称不存在。格式为 projects/{projectId}/databases/{databaseId}/documents/{document_path}。

授权范围

需要以下 OAuth 范围之一：

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

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