REST Resource: projects.databases

資源:資料庫

Cloud Firestore 資料庫。

JSON 表示
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "locationId": string,
  "type": enum (DatabaseType),
  "concurrencyMode": enum (ConcurrencyMode),
  "versionRetentionPeriod": string,
  "earliestVersionTime": string,
  "pointInTimeRecoveryEnablement": enum (PointInTimeRecoveryEnablement),
  "appEngineIntegrationMode": enum (AppEngineIntegrationMode),
  "keyPrefix": string,
  "deleteProtectionState": enum (DeleteProtectionState),
  "etag": string
}
領域
name

string

資料庫的資源名稱。格式: projects/{project}/databases/{database}

uid

string

僅輸出。系統為此資料庫產生的 UUID4。

createTime

string ( Timestamp format)

僅輸出。建立此資料庫的時間戳記。 2016 年之前建立的資料庫不會填入 createTime。

RFC3339 UTC「Zulu」格式的時間戳,具有奈秒解析度和最多九個小數位。範例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string ( Timestamp format)

僅輸出。該資料庫最近更新的時間戳。請注意,這僅包括對資料庫資源的更新,而不包括資料庫包含的資料。

RFC3339 UTC「Zulu」格式的時間戳,具有奈秒解析度和最多九個小數位。範例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

locationId

string

資料庫的位置。 https://cloud.google.com/firestore/docs/locations列出了可用位置。

type

enum ( DatabaseType )

資料庫的類型。有關如何選擇的信息,請參閱https://cloud.google.com/datastore/docs/firestore-or-datastore

concurrencyMode

enum ( ConcurrencyMode )

用於此資料庫的並發控制模式。

versionRetentionPeriod

string ( Duration format)

僅輸出。過去版本的資料保留在資料庫中的時間段。

任何readquery都可以在此視窗內指定一個readTime ,並將讀取當時資料庫的狀態。

若啟用 PITR 功能,保留期為 7 天。否則,保留期限為 1 小時。

以秒為單位的持續時間,最多包含九個小數位,以「 s 」結尾。例: "3.5s"

earliestVersionTime

string ( Timestamp format)

僅輸出。可以從資料庫讀取舊版本資料的最早時間戳記。請參閱上面的[版本保留期];此欄位填入有now - versionRetentionPeriod

該值會不斷更新,並在被查詢時就變得過時。如果您使用此值來恢復數據,請確保考慮從查詢該值到啟動恢復的時間。

RFC3339 UTC「Zulu」格式的時間戳,具有奈秒解析度和最多九個小數位。範例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

pointInTimeRecoveryEnablement

enum ( PointInTimeRecoveryEnablement )

是否在此資料庫上啟用 PITR 功能。

appEngineIntegrationMode

enum ( AppEngineIntegrationMode )

用於此資料庫的 App Engine 整合模式。

keyPrefix

string

僅輸出。該資料庫的 keyPrefix。此 keyPrefix 與項目 id 結合使用(“ ") 來建構從 Google App Engine 第一代執行時期中的 Cloud Datastore API 傳回的應用程式 ID。

該值可能為空,在這種情況下,用於 URL 編碼鍵的 appid 是 projectId(例如:foo 而不是 v~foo)。

deleteProtectionState

enum ( DeleteProtectionState )

資料庫的刪除保護狀態。

etag

string

此校驗和由伺服器根據其他欄位的值計算,並且可以在更新和刪除請求時發送,以確保客戶端在繼續操作之前具有最新的值。

資料庫類型

資料庫的類型。有關如何選擇的信息,請參閱https://cloud.google.com/datastore/docs/firestore-or-datastore

僅當資料庫為空時才允許模式變更。

列舉
DATABASE_TYPE_UNSPECIFIED預設值.如果省略資料庫類型,則使用此值。
FIRESTORE_NATIVE Firestore 本機模式
DATASTORE_MODE資料儲存模式下的 Firestore。

並發模式

事務的並發控制模式類型。

列舉
CONCURRENCY_MODE_UNSPECIFIED不曾用過。
OPTIMISTIC預設使用樂觀並發控制。此模式適用於 Cloud Firestore 資料庫。
PESSIMISTIC

預設使用悲觀並發控制。此模式適用於 Cloud Firestore 資料庫。

這是 Cloud Firestore 的預設值。

OPTIMISTIC_WITH_ENTITY_GROUPS

預設對實體群組使用樂觀並發控制。

這是 Cloud Datastore 的唯一可用模式。

此模式也適用於具有資料儲存模式的 Cloud Firestore,但不建議使用。

時間點恢復啟用

時間點恢復功能啟用。

列舉
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED不曾用過。
POINT_IN_TIME_RECOVERY_ENABLED

支援讀取過去 7 天內選定的資料版本:

  • 讀取過去一小時內的任何時間戳
  • 讀取 1 小時以上、7 天內的 1 分鐘快照

versionRetentionPeriodearliestVersionTime可用於確定支援的版本。

POINT_IN_TIME_RECOVERY_DISABLED支援讀取過去 1 小時內任何版本的資料。

AppEngine整合模式

App Engine 整合模式的類型。

列舉
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED不曾用過。
ENABLED如果 App Engine 應用程式與此資料庫位於相同區域,則 App Engine 配置將影響此資料庫。這包括禁用應用程式和資料庫,以及禁用對資料庫的寫入。
DISABLED

App Engine 不會影響該資料庫處理請求的能力。

這是使用 Firestore API 建立的資料庫的預設值。

刪除保護狀態

資料庫的刪除保護狀態。

列舉
DELETE_PROTECTION_STATE_UNSPECIFIED預設值.未指定刪除保護類型
DELETE_PROTECTION_DISABLED刪除保護已停用
DELETE_PROTECTION_ENABLED刪除保護已啟用

方法

create

建立資料庫。

delete

刪除資料庫。

exportDocuments

將全部或部分文件的副本從 Google Cloud Firestore 匯出到另一個儲存系統,例如 Google Cloud Storage。

get

取得有關資料庫的資訊。

importDocuments

將文件匯入 Google Cloud Firestore。

list

列出項目中的所有資料庫。

patch

更新資料庫。

restore

透過從現有備份還原來建立新資料庫。