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 世界標準時間「Zulu」的時間戳記格式,解析度為奈秒,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

僅供輸出。上次變更文件的時間。

這個值一開始會設為 createTime,然後在每次變更文件時單調遞增。您也可以使用其他文件的值和查詢的 readTime 進行比較。

RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度為奈秒,且最多 9 個小數位數。範例:"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

執行查詢。