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),
  "cmekConfig": {
    object (CmekConfig)
  },
  "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"。
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 はプロジェクト ID（「~」）と組み合わせて、Google App Engine 第 1 世代ランタイムで Cloud Datastore API から返されるアプリケーション ID を構築するために使用されます。

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

enum (DeleteProtectionState)

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

object (CmekConfig)

省略可。Presence は、このデータベースで CMEK が有効になっていることを示します。
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 でも使用できますが、推奨されません。

PointInTimeRecoveryEnablement

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

列挙型
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 マルチリージョン europe に対応します。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

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