REST Resource: projects.databases.documents

资源:Document

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,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

仅限输出。上次更改文档的时间。

此值最初设置为 createTime,然后随文档的每次更改单调递增。还可将其与其他文档中的值和查询的 readTime 进行比较。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"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

运行查询。