REST Resource: projects.databases

リソース: データベース

Cloud Firestore データベース。

JSON 表現 
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "locationId": string,
  "type": enum (DatabaseType),
  "concurrencyMode": enum (ConcurrencyMode),
  "versionRetentionPeriod": string,
  "earliestVersionTime": string,
  "pointInTimeRecoveryEnablement": enum (PointInTimeRecoveryEnablement),
  "appEngineIntegrationMode": enum (AppEngineIntegrationMode),
  "keyPrefix": string,
  "deleteProtectionState": enum (DeleteProtectionState),
  "cmekConfig": {
    object (CmekConfig)
  },
  "previousId": string,
  "etag": string
}
フィールド
name

string

データベースのリソース名。形式: projects/{project}/databases/{database}
uid

string

出力専用。このデータベースに対してシステムによって生成された UUID4。
createTime

string (Timestamp format)

出力専用。このデータベースが作成された時点のタイムスタンプ。2016 年より前に作成されたデータベースでは、createTime に値が入力されません。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

出力専用。このデータベースが最後に更新されたタイムスタンプ。これにはデータベース リソースの更新のみが含まれ、データベースに含まれるデータの更新は含まれないことに注意してください。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
deleteTime

string (Timestamp format)

出力専用。このデータベースが削除された時点のタイムスタンプ。データベースが削除された場合にのみ設定されます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "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)

出力専用。過去のバージョンのデータがデータベースに保持される期間。

任意の read または query は、このウィンドウ内で readTime を指定でき、その時点でのデータベースの状態を読み取ります。

PITR 機能が有効な場合、保持期間は 7 日間です。それ以外の場合の保持期間は 1 時間です。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
earliestVersionTime

string (Timestamp format)

出力専用。古いバージョンのデータをデータベースから読み取れる最も古いタイムスタンプ。上記の [versionRetentionPeriod] をご覧ください。このフィールドには now - versionRetentionPeriod が入力されます。

この値は継続的に更新され、クエリを実行するとすぐに陳腐化します。この値を使用してデータを復元する場合、値がクエリされてから復元を行うまでの間に経過した時間を考慮する必要があります。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
pointInTimeRecoveryEnablement

enum (PointInTimeRecoveryEnablement)

このデータベースで PITR 機能を有効にするかどうかを指定します。
appEngineIntegrationMode

enum (AppEngineIntegrationMode)

このデータベースに使用する App Engine 統合モード。
keyPrefix

string

出力専用。このデータベースの keyPrefix。この keyPrefix は、Google App Engine 第 1 世代ランタイムの Cloud Datastore API から返されるアプリケーション ID を作成するために、プロジェクト ID（「~」）と組み合わせて使用されます。

この値は空でもかまいません。この場合、URL エンコードされたキーに使用する appid は projectId です（例: v~foo ではなく foo ）。
deleteProtectionState

enum (DeleteProtectionState)

データベースの削除保護の状態。
cmekConfig

object (CmekConfig)

省略可。存在する場合は、このデータベースで CMEK が有効になっていることを示します。
previousId

string

出力専用。データベース リソースの以前のデータベース ID。このフィールドは、削除されたデータベースに対してのみ入力されます。
etag

string

このチェックサムは、他のフィールドの値に基づいてサーバーによって計算されて、更新リクエストと削除リクエストで送信され、続行する前にクライアントが最新の値を持っていることを確認できます。

DatabaseType

データベースのタイプ。選択方法については、https://cloud.google.com/datastore/docs/firestore-or-datastore をご覧ください。

モードの変更は、データベースが空の場合にのみ許可されます。

列挙型
DATABASE_TYPE_UNSPECIFIED デフォルト値。データベースの種類を省略すると、この値が使用されます。
FIRESTORE_NATIVE Firestore ネイティブ モード
DATASTORE_MODE Datastore モードの Firestore。

ConcurrencyMode

トランザクションの同時実行制御モードのタイプ。

列挙型
CONCURRENCY_MODE_UNSPECIFIED 使用されません。
OPTIMISTIC オプティミスティック同時実行制御をデフォルトで使用します。このモードは Cloud Firestore データベースで使用できます。
PESSIMISTIC

ペシミスティック同時実行制御をデフォルトで使用する。このモードは Cloud Firestore データベースで使用できます。

これは Cloud Firestore のデフォルト設定です。
OPTIMISTIC_WITH_ENTITY_GROUPS

デフォルトで、エンティティ グループでオプティミスティック同時実行制御を使用します。

Cloud Datastore ではこのモードのみを使用できます。

このモードは、Datastore モードの Cloud Firestore でも使用できますが、おすすめしません。

ポイントインタイム リカバリの有効化

ポイントインタイム リカバリ機能の有効化

列挙型
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED 使用されません。
POINT_IN_TIME_RECOVERY_ENABLED

読み取りは、過去 7 日間のデータの一部のバージョンでサポートされています。

  • 過去 1 時間以内の任意のタイムスタンプに対して読み取ります
  • 1 時間を超えて 7 日以内の 1 分間のスナップショットを読み取る

versionRetentionPeriod と earliestVersionTime を使用すると、サポートされているバージョンを確認できます。
POINT_IN_TIME_RECOVERY_DISABLED 読み取りは、過去 1 時間以内のデータの任意のバージョンでサポートされています。

AppEngineIntegrationMode

App Engine 統合モードのタイプ。

列挙型
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED 使用されません。
ENABLED App Engine アプリケーションがこのデータベースと同じリージョンにある場合、App Engine の構成はこのデータベースに影響します。これには、アプリケーションの無効化とデータベースへの書き込みを無効にすることも できます
DISABLED

App Engine は、このデータベースのリクエストを処理する機能に影響しません。

これは、Firestore API で作成されたデータベースのデフォルト設定です。

DeleteProtectionState

データベースの削除保護の状態。

列挙型
DELETE_PROTECTION_STATE_UNSPECIFIED デフォルト値。削除保護タイプが指定されていません
DELETE_PROTECTION_DISABLED 削除保護が無効になっています
DELETE_PROTECTION_ENABLED 削除保護が有効です

CmekConfig

Firestore データベースの CMEK（顧客管理の暗号鍵）構成。存在しない場合、データベースはデフォルトの Google 暗号鍵によって保護されます。

JSON 表現 
{
  "kmsKeyName": string,
  "activeKeyVersion": [
    string
  ]
}
フィールド
kmsKeyName

string

必須。暗号化に使用できるのは、このデータベースと同じロケーションにある鍵のみです。

Firestore の nam5 マルチリージョンの場合、これは Cloud KMS マルチリージョンの us に対応します。Firestore の eur3 マルチリージョンの場合、これは Cloud KMS マルチリージョン（ヨーロッパ）に対応します。https://cloud.google.com/kms/docs/locations をご覧ください。

想定される形式は projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key} です。
activeKeyVersion[]

string

出力専用。現在使用中の KMS 鍵バージョン。鍵のローテーション中は、複数の使用中の鍵バージョンが存在する可能性があります。

想定される形式は projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version} です。

メソッド

create

 データベースを作成します。

delete

 データベースを削除します。

exportDocuments

 Google Cloud Firestore から別のストレージ システム（Google Cloud Storage など）に、すべてまたは一部のドキュメントのコピーをエクスポートします。

get

 データベースに関する情報を取得します。

importDocuments

 ドキュメントを Google Cloud Firestore にインポートする。

list

 プロジェクト内のすべてのデータベースを一覧表示します。

patch

 データベースを更新します。

restore

 既存のバックアップから復元して新しいデータベースを作成します。