postgresコマンドグループ
この情報は、Databricks CLI バージョン 0.285 以降に適用されます。Databricks CLI はパブリック プレビュー段階です。
Databricks CLI使用には、使用状況データ プロビジョニングを含むDatabricksライセンスおよびDatabricksプライバシー通知が適用されます。
Databricks CLI内のpostgresコマンド グループには、プロジェクト、ブランチ、エンドポイントなどの Lakebase Postgres リソースを管理するためのコマンドが含まれています。 Postgres API は、REST API または直接 SQL を介して Postgres データベースへのアクセスを提供します。
データブリックス PostgreSQL ブランチ作成
ブランチを作成します。
これは長時間実行される操作です。デフォルトでは、コマンドは操作が完了するまで待機します。生の操作詳細を直ちに返すには、 --no-waitを使用します。操作のnameフィールドは、 get-operationコマンドを使用して完了をポーリングするために使用できます。
databricks postgres create-branch PARENT BRANCH_ID [flags]
議論
PARENT
このブランチが作成されるプロジェクト。形式： projects/{project_id}
BRANCH_ID
ブランチに使用する ID。これはブランチのリソース名の最後のコンポーネントになります。1 ～ 63 文字の長さで、小文字で始まり、小文字、数字、ハイフンのみを含める必要があります (RFC 1123)。
オプション
--json JSON
インライン JSON 文字列またはリクエスト本体を含む JSON ファイルへの @path。
--name string
ブランチのリソース名。
--no-wait
DONE 状態に達するまで待たないでください。
--timeout duration
DONE 状態に到達するまでの最大時間。
例
次の例では、プロジェクトにブランチを作成します。
databricks postgres create-branch projects/my-project-id my-branch \
--json '{
"spec": {
"no_expiry": true
}
}'
次の例では、既存のブランチからブランチを作成します。
databricks postgres create-branch projects/my-project-id dev-branch \
--json '{
"spec": {
"source_branch": "projects/my-project-id/branches/main",
"no_expiry": true
}
}'
Databricks PostgreSQL エンドポイント作成
エンドポイントを作成します。
これは長時間実行される操作です。デフォルトでは、コマンドは操作が完了するまで待機します。生の操作詳細を直ちに返すには、 --no-waitを使用します。操作のnameフィールドは、 get-operationコマンドを使用して完了をポーリングするために使用できます。
databricks postgres create-endpoint PARENT ENDPOINT_ID [flags]
議論
PARENT
このエンドポイントが作成されるブランチ。形式： projects/{project_id}/branches/{branch_id}
ENDPOINT_ID
エンドポイントに使用する ID。エンドポイントのリソース名の最後のコンポーネントになります。1 ～ 63 文字の長さで、小文字で始まり、小文字、数字、ハイフンのみを含める必要があります (RFC 1123)。
オプション
--json JSON
インライン JSON 文字列またはリクエスト本体を含む JSON ファイルへの @path。
--name string
エンドポイントのリソース名。
--no-wait
DONE 状態に達するまで待たないでください。
--timeout duration
DONE 状態に到達するまでの最大時間。
例
次の例では、ブランチに読み取り/書き込みエンドポイントを作成します。
databricks postgres create-endpoint projects/my-project-id/branches/my-branch-id my-endpoint \
--json '{
"spec": {
"endpoint_type": "ENDPOINT_TYPE_READ_WRITE",
"autoscaling_limit_min_cu": 0.5,
"autoscaling_limit_max_cu": 4.0
}
}'
次の例では、読み取り専用エンドポイント (読み取りレプリカ) を作成します。
databricks postgres create-endpoint projects/my-project-id/branches/my-branch-id read-replica-1 \
--json '{
"spec": {
"endpoint_type": "ENDPOINT_TYPE_READ_ONLY",
"autoscaling_limit_min_cu": 0.5,
"autoscaling_limit_max_cu": 4.0
}
}'
Databricks Postgres プロジェクト作成
プロジェクトを作成します。
これは長時間実行される操作です。デフォルトでは、コマンドは操作が完了するまで待機します。生の操作詳細を直ちに返すには、 --no-waitを使用します。操作のnameフィールドは、 get-operationコマンドを使用して完了をポーリングするために使用できます。
databricks postgres create-project PROJECT_ID [flags]
議論
PROJECT_ID
プロジェクトに使用する ID。プロジェクトのリソース名の最後のコンポーネントになります。1 ～ 63 文字の長さで、小文字で始まり、小文字、数字、ハイフンのみを含める必要があります (RFC 1123)。
オプション
--json JSON
インライン JSON 文字列またはリクエスト本体を含む JSON ファイルへの @path。
--name string
プロジェクトのリソース名。
--no-wait
DONE 状態に達するまで待たないでください。
--timeout duration
DONE 状態に到達するまでの最大時間。
例
次の例では、プロジェクトを作成します。
databricks postgres create-project my-project \
--json '{
"spec": {
"display_name": "My Project"
}
}'
次の例では、特定の PostgreSQL バージョンでプロジェクトを作成します。
databricks postgres create-project my-project \
--json '{
"spec": {
"display_name": "My Project",
"pg_version": "17"
}
}'
Databricks Postgres ブランチ削除
ブランチを削除します。
これは長時間実行される操作です。デフォルトでは、コマンドは操作が完了するまで待機します。生の操作詳細を直ちに返すには、 --no-waitを使用します。操作のnameフィールドは、 get-operationコマンドを使用して完了をポーリングするために使用できます。
databricks postgres delete-branch NAME [flags]
議論
NAME
削除するブランチの名前。形式： projects/{project_id}/branches/{branch_id}
オプション
--no-wait
DONE 状態に達するまで待たないでください。
--timeout duration
DONE 状態に到達するまでの最大時間。
例
次の例では、ブランチを削除します。
databricks postgres delete-branch projects/my-project-id/branches/my-branch-id
Databricks Postgres エンドポイントの削除
エンドポイントを削除します。
これは長時間実行される操作です。デフォルトでは、コマンドは操作が完了するまで待機します。生の操作詳細を直ちに返すには、 --no-waitを使用します。操作のnameフィールドは、 get-operationコマンドを使用して完了をポーリングするために使用できます。
databricks postgres delete-endpoint NAME [flags]
議論
NAME
削除するエンドポイントの名前。形式： projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
オプション
--no-wait
DONE 状態に達するまで待たないでください。
--timeout duration
DONE 状態に到達するまでの最大時間。
例
次の例では、エンドポイントを削除します。
databricks postgres delete-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id
Databricks Postgres プロジェクトの削除
プロジェクトを削除します。
これは長時間実行される操作です。デフォルトでは、コマンドは操作が完了するまで待機します。生の操作詳細を直ちに返すには、 --no-waitを使用します。操作のnameフィールドは、 get-operationコマンドを使用して完了をポーリングするために使用できます。
databricks postgres delete-project NAME [flags]
議論
NAME
削除するプロジェクトの名前。形式： projects/{project_id}
オプション
--no-wait
DONE 状態に達するまで待たないでください。
--timeout duration
DONE 状態に到達するまでの最大時間。
例
次の例では、プロジェクトを削除します。
databricks postgres delete-project projects/my-project-id
Databricks Postgres データベース認証情報の生成
Postgres データベースの OAuth 資格情報を生成します。
databricks postgres generate-database-credential ENDPOINT [flags]
議論
ENDPOINT
この資格情報が生成されるエンドポイント。形式： projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
オプション
--json JSON
インライン JSON 文字列またはリクエスト本体を含む JSON ファイルへの @path。
例
次の例では、エンドポイントの OAuth 資格情報を生成します。
databricks postgres generate-database-credential projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id
データブリックス postgres ブランチ取得
ブランチを取得します。
databricks postgres get-branch NAME [flags]
議論
NAME
取得するブランチの名前。形式： projects/{project_id}/branches/{branch_id}
オプション
例
次の例では、ブランチに関する情報を取得します。
databricks postgres get-branch projects/my-project-id/branches/my-branch-id
Databricks Postgres エンドポイント取得
エンドポイントを取得します。
databricks postgres get-endpoint NAME [flags]
議論
NAME
取得するエンドポイントの名前。形式： projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
オプション
例
次の例では、エンドポイントに関する情報を取得します。
databricks postgres get-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id
Databricks Postgres 取得操作
手術を受けてください。
databricks postgres get-operation NAME [flags]
議論
NAME
操作リソースの名前。
オプション
例
次の例では、操作に関する情報を取得します。
databricks postgres get-operation projects/my-project-id/operations/my-operation-id
データブリックス postgres プロジェクトの取得
プロジェクトを取得します。
databricks postgres get-project NAME [flags]
議論
NAME
取得するプロジェクトの名前。形式： projects/{project_id}
オプション
例
次の例では、プロジェクトに関する情報を取得します。
databricks postgres get-project projects/my-project-id
Databricks Postgres リストブランチ
ブランチを一覧表示します。
databricks postgres list-branches PARENT [flags]
議論
PARENT
このブランチのコレクションを所有するプロジェクト。形式： projects/{project_id}
オプション
--page-size int
返されるアイテムの上限。
--page-token string
前の応答からのページ トークン。
例
次の例では、プロジェクト内のすべてのブランチを一覧表示します。
databricks postgres list-branches projects/my-project-id
次の例では、ページ区切り付きのブランチをリストします。
databricks postgres list-branches projects/my-project-id --page-size 10
Databricks Postgres リストエンドポイント
エンドポイントを一覧表示します。
databricks postgres list-endpoints PARENT [flags]
議論
PARENT
このエンドポイントのコレクションを所有するブランチ。形式： projects/{project_id}/branches/{branch_id}
オプション
--page-size int
返されるアイテムの上限。
--page-token string
前の応答からのページ トークン。
例
次の例では、ブランチ内のすべてのエンドポイントを一覧表示します。
databricks postgres list-endpoints projects/my-project-id/branches/my-branch-id
次の例では、ページ区切りのあるエンドポイントをリストします。
databricks postgres list-endpoints projects/my-project-id/branches/my-branch-id --page-size 10
Databricks Postgres プロジェクト一覧
プロジェクトを一覧表示します。
databricks postgres list-projects [flags]
オプション
--page-size int
返されるアイテムの上限。
--page-token string
前の応答からのページ トークン。
例
次の例では、すべてのプロジェクトを一覧表示します。
databricks postgres list-projects
次の例では、ページ区切りを使用してプロジェクトをリストします。
databricks postgres list-projects --page-size 10
データブリックス PostgreSQL ブランチ更新
ブランチを更新します。
これは長時間実行される操作です。デフォルトでは、コマンドは操作が完了するまで待機します。生の操作詳細を直ちに返すには、 --no-waitを使用します。操作のnameフィールドは、 get-operationコマンドを使用して完了をポーリングするために使用できます。
databricks postgres update-branch NAME UPDATE_MASK [flags]
議論
NAME
ブランチのリソース名。形式： projects/{project_id}/branches/{branch_id}
UPDATE_MASK
更新するフィールドのリスト。指定しない場合は、可能な場合はすべてのフィールドが更新されます。
オプション
--json JSON
インライン JSON 文字列またはリクエスト本体を含む JSON ファイルへの @path。
--name string
ブランチのリソース名。
--no-wait
DONE 状態に達するまで待たないでください。
--timeout duration
DONE 状態に到達するまでの最大時間。
例
次の例では、ブランチを更新して保護されるようにします。
databricks postgres update-branch projects/my-project-id/branches/my-branch-id spec.is_protected \
--json '{
"spec": {
"is_protected": true
}
}'
Databricks Postgres エンドポイント更新
エンドポイントを更新します。
これは長時間実行される操作です。デフォルトでは、コマンドは操作が完了するまで待機します。生の操作詳細を直ちに返すには、 --no-waitを使用します。操作のnameフィールドは、 get-operationコマンドを使用して完了をポーリングするために使用できます。
databricks postgres update-endpoint NAME UPDATE_MASK [flags]
議論
NAME
エンドポイントのリソース名。形式： projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
UPDATE_MASK
更新するフィールドのリスト。指定しない場合は、可能な場合はすべてのフィールドが更新されます。
オプション
--json JSON
インライン JSON 文字列またはリクエスト本体を含む JSON ファイルへの @path。
--name string
エンドポイントのリソース名。
--no-wait
DONE 状態に達するまで待たないでください。
--timeout duration
DONE 状態に到達するまでの最大時間。
例
次の例では、エンドポイントの最大コンピュート単位を更新します。
databricks postgres update-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id spec.autoscaling_limit_max_cu \
--json '{
"spec": {
"autoscaling_limit_max_cu": 8.0
}
}'
次の例では、複数のフィールド (最小および最大コンピュート単位) を更新します。
databricks postgres update-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id "spec.autoscaling_limit_min_cu,spec.autoscaling_limit_max_cu" \
--json '{
"spec": {
"autoscaling_limit_min_cu": 1.0,
"autoscaling_limit_max_cu": 8.0
}
}'
Databricks Postgres 更新プロジェクト
プロジェクトを更新します。
これは長時間実行される操作です。デフォルトでは、コマンドは操作が完了するまで待機します。生の操作詳細を直ちに返すには、 --no-waitを使用します。操作のnameフィールドは、 get-operationコマンドを使用して完了をポーリングするために使用できます。
databricks postgres update-project NAME UPDATE_MASK [flags]
議論
NAME
プロジェクトのリソース名。形式： projects/{project_id}
UPDATE_MASK
更新するフィールドのリスト。指定しない場合は、可能な場合はすべてのフィールドが更新されます。
オプション
--json JSON
インライン JSON 文字列またはリクエスト本体を含む JSON ファイルへの @path。
--name string
プロジェクトのリソース名。
--no-wait
DONE 状態に達するまで待たないでください。
--timeout duration
DONE 状態に到達するまでの最大時間。
例
次の例では、プロジェクトの表示名を更新します。
databricks postgres update-project projects/my-project-id spec.display_name \
--json '{
"spec": {
"display_name": "Updated Project Name"
}
}'
グローバルフラグ
--debug
デバッグ ログを有効にするかどうか。
-h または --help
Databricks CLI または関連コマンド グループまたは関連コマンドのヘルプを表示します。
--log-file string
出力ログを書き込むファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログは stderr に書き込まれます。
--log-format format
ログ形式のタイプ、 textまたはjson 。デフォルト値はtextです。
--log-level string
ログ形式のレベルを表す文字列。指定しない場合は、ログ形式のレベルは無効になります。
-o, --output タイプ
コマンド出力タイプ、 textまたはjson 。デフォルト値はtextです。
-p, --profile string
コマンドを実行するために使用する~/.databrickscfgファイル内のプロファイルの名前。このフラグが指定されていない場合、存在する場合は、 DEFAULTという名前のプロファイルが使用されます。
--progress-format format
進捗ログを表示する形式: default 、 append 、 inplace 、または json
-t, --target string
該当する場合、使用するバンドルターゲット