REST Resource: projects.databases

リソース: データベース

クラウド 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」形式のタイムスタンプ。ナノ秒の分解能と最大 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 )

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

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 でも使用できますが、推奨されません。

PointInTimeRecoveryEnablement

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

列挙型
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED使用されていない。
POINT_IN_TIME_RECOVERY_ENABLED

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

  • 過去 1 時間以内のタイムスタンプを読み取ります
  • 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

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