Method: projects.databases.documents.commit

提交事务,同时可以选择更新文档。

HTTP请求

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

URL 使用gRPC 转码语法。

路径参数

参数
database

string

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

请求正文

请求正文包含具有以下结构的数据:

JSON 表示
{
  "writes": [
    {
      object (Write)
    }
  ],
  "transaction": string
}
领域
writes[]

object ( Write )

写入应用。

始终以原子方式按顺序执行。

transaction

string ( bytes format)

如果设置,则应用此事务中的所有写入,并提交它。

Base64 编码的字符串。

响应体

Firestore.Commit的响应。

如果成功,响应正文包含具有以下结构的数据:

JSON 表示
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "commitTime": string
}
领域
writeResults[]

object ( WriteResult )

应用写入的结果。

该第i次写入结果对应于请求中的第i次写入。

commitTime

string ( Timestamp format)

提交发生的时间。任何具有等于或更大readTime读取都保证能看到提交的效果。

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

有关详细信息,请参阅身份验证概述