REST Resource: projects.databases.documents

资源:文档

Firestore 文档。

不得超过 1 MiB - 4 字节。

JSON 表示
{
  "name": string,
  "fields": {
    string: {
      object (Value)
    },
    ...
  },
  "createTime": string,
  "updateTime": string
}
领域
name

string

文档的资源名称,例如projects/{projectId}/databases/{databaseId}/documents/{document_path}

fields

map (key: string, value: object ( Value ))

包含"key": value对。示例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

createTime

string ( Timestamp format)

仅输出。创建文档的时间。

当文档被删除然后重新创建时,该值单调增加。它还可以与其他文档的值和查询的readTime进行比较。

RFC3339 UTC“Zulu”格式的时间戳,具有纳秒分辨率和最多九个小数位。示例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string ( Timestamp format)

仅输出。文档最后一次更改的时间。

该值最初设置为createTime ,然后随着文档的每次更改而单调增加。它还可以与其他文档的值和查询的readTime进行比较。

RFC3339 UTC“Zulu”格式的时间戳,具有纳秒分辨率和最多九个小数位。示例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

方法

batchGet

获取多个文档。

batchWrite

应用一批写操作。

beginTransaction

开始新的交易。

commit

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

createDocument

创建一个新文档。

delete

删除文档。

get

获取单个文档。

list

列出文档。

listCollectionIds

列出文档下的所有集合 ID。

listDocuments

列出文档。

partitionQuery

通过返回可用于并行运行查询的分区游标对查询进行分区。

patch

更新或插入文档。

rollback

回滚事务。

runAggregationQuery

运行聚合查询。

runQuery

运行查询。