Google is committed to advancing racial equity for Black communities. See how.
本頁面由 Cloud Translation API 翻譯而成。
Switch to English

REST Resource: projects.databases.documents

資源:文件

Firestore文檔。

不得超過1 MiB-4個字節。

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

string

文檔的資源名稱,例如projects/{project_id}/databases/{databaseId}/documents/{document_path}

fields

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

文檔的字段。

映射鍵代表字段名稱。

一個簡單的字段名稱僅包含字符azAZ09_ ,並且不能以09開頭。例如, foo_bar_17

保留與正則表達式__.*__匹配的字段名稱。除非在某些文檔說明的上下文中,否則保留字段名稱是禁止的。映射鍵(表示為UTF-8)不得超過1,500個字節,並且不能為空。

字段路徑可以在其他上下文中用於引用此處定義的結構化字段。對於mapValue ,字段路徑由包含字段的簡單或帶引號的字段名稱表示,以分隔. 。例如,結構化字段"foo" : { mapValue: { "x&y" : { stringValue: "hello" }}}將由字段路徑foo.x&y

在字段路徑中,帶引號的字段名稱以`開頭和結尾,並且可以包含任何字符。某些字符(包括` )必須使用\進行轉義。例如, `x&y` x&y `bak\`tik`代表x&y`bak\`tik`代表bak`tik

包含"key": value對列表的對象。示例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

createTime

string ( Timestamp format)

僅輸出。文檔創建的時間。

當刪除文檔然後重新創建時,該值單調增加。也可以將其與其他文檔中的值以及查詢的readTime進行比較。

RFC3339 UTC“ Zulu”格式的時間戳,具有納秒級分辨率和最多9個小數位。示例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string ( Timestamp format)

僅輸出。上次更改文檔的時間。

此值最初設置為createTime然後隨文檔的每次更改單調增加。也可以將其與其他文檔中的值以及查詢的readTime進行比較。

RFC3339 UTC“ Zulu”格式的時間戳,具有納秒級分辨率和最多9個小數位。示例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

方法

batchGet

獲取多個文檔。

batchWrite

應用一批寫操作。

beginTransaction

開始新交易。

commit

提交事務,同時可以選擇更新文檔。

createDocument

創建一個新文檔。

delete

刪除文件。

get

獲取單個文檔。

list

列出文件。

listCollectionIds

列出文檔下面的所有集合ID。

partitionQuery

通過返回可用於並行運行查詢的分區游標,對查詢進行分區。

patch

更新或插入文檔。

rollback

回滾事務。

runQuery

運行查詢。