postgres コマンド グループ

注

この情報は、Databricks CLI バージョン 0.285 以降に適用されます。

Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。

postgres 内の コマンド グループには、プロジェクト、ブランチ、エンドポイントなどの Lakebase Postgres リソースを管理するためのコマンドが含まれています。 Postgres API は、REST API または直接 SQL を介して Postgres データベースへのアクセスを提供します。

databricks postgres create-branch

ブランチを作成します。 ブランチを作成するときは、永続的ブランチの no_expiry: true を使用して有効期限ポリシーを指定する必要があります。

注

これは実行時間の長い操作です。 既定では、コマンドは操作の完了を待機します。 --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 postgres create-endpoint

エンドポイントを作成します。 ブランチには、1 つの読み取り/書き込みコンピューティング エンドポイントと、読み取り操作をスケーリングするための複数の読み取り専用エンドポイント (読み取りレプリカ) を含めることができます。

注

これは実行時間の長い操作です。 既定では、コマンドは操作の完了を待機します。 --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 create-project

プロジェクトを作成します。

注

これは実行時間の長い操作です。 既定では、コマンドは操作の完了を待機します。 --no-waitを使用して、未加工の操作の詳細をすぐに返します。 その後、操作の name フィールドを使用して、 get-operation コマンドを使用して完了をポーリングできます。

プロジェクトを作成すると、既定の運用ブランチと読み取り/書き込みコンピューティング エンドポイントが自動的に含まれます。両方とも自動生成された ID が含まれます。

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 create-role

ブランチの Postgres ロールを作成します。

注

これは実行時間の長い操作です。 既定では、コマンドは操作の完了を待機します。 --no-waitを使用して、未加工の操作の詳細をすぐに返します。 その後、操作の name フィールドを使用して、 get-operation コマンドを使用して完了をポーリングできます。

databricks postgres create-role PARENT [flags]

論争

PARENT

    このロールが作成されるブランチ。 形式: projects/{project_id}/branches/{branch_id}.

オプション

--json JSON

    要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。

--name string

    ロールのリソース名 (出力のみ)。

--no-wait

    DONE 状態に達するまで待つ必要はありません。

--role-id string

    ロールに使用する ID。ロールのリソース名の最後のコンポーネントになります。

--timeout duration

    DONE 状態に達するまでの最大時間。

グローバル フラグ

例示

次の例では、ブランチにパスワードベースのロールを作成します。

databricks postgres create-role projects/my-project-id/branches/my-branch-id \
  --role-id my-role \
  --json '{"spec": {"postgres_role": "my-role"}}'

次の例では、Databricks ユーザーの OAuth ロールを作成します。

databricks postgres create-role projects/my-project-id/branches/my-branch-id \
  --role-id my-user-role \
  --json '{"spec": {"identity_type": "USER", "postgres_role": "user@example.com"}}'

databricks postgres delete-branch

ブランチを削除します。

注

これは実行時間の長い操作です。 既定では、コマンドは操作の完了を待機します。 --no-waitを使用して、未加工の操作の詳細をすぐに返します。 その後、操作の name フィールドを使用して、 get-operation コマンドを使用して完了をポーリングできます。

保護されたブランチは削除できません。 update-branchを使用して、削除する前にspec.is_protectedをfalseに設定します。

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 delete-endpoint

エンドポイントを削除します。

注

これは実行時間の長い操作です。 既定では、コマンドは操作の完了を待機します。 --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 delete-project

プロジェクトを削除します。

注

これは実行時間の長い操作です。 既定では、コマンドは操作の完了を待機します。 --no-waitを使用して、未加工の操作の詳細をすぐに返します。 その後、操作の name フィールドを使用して、 get-operation コマンドを使用して完了をポーリングできます。

databricks postgres delete-project NAME [flags]

論争

NAME

    削除するプロジェクトの名前。 形式: projects/{project_id}

オプション

--no-wait

    DONE 状態になるまで待つ必要はありません。

--purge

    true の場合、プロジェクトを完全に削除します (ハード削除)。

--timeout duration

    DONE 状態に達するまでの最大時間。

グローバル フラグ

例示

次の例では、プロジェクトを論理的に削除します (7 日間回復可能)。

databricks postgres delete-project projects/my-project-id

次の例では、プロジェクトを完全に削除します。

databricks postgres delete-project projects/my-project-id --purge

databricks postgres delete-role

ブランチから Postgres ロールを削除します。

注

これは実行時間の長い操作です。 既定では、コマンドは操作の完了を待機します。 --no-waitを使用して、未加工の操作の詳細をすぐに返します。 その後、操作の name フィールドを使用して、 get-operation コマンドを使用して完了をポーリングできます。

databricks postgres delete-role NAME [flags]

論争

NAME

    削除するロールの完全なリソース パス。 形式: projects/{project_id}/branches/{branch_id}/roles/{role_id}.

オプション

--no-wait

    DONE 状態に達するまで待つ必要はありません。

--reassign-owned-to string

    削除されたロールが所有するオブジェクトをこのロールに再割り当てします。

--timeout duration

    DONE 状態に達するまでの最大時間。

グローバル フラグ

例示

次の例では、ブランチからロールを削除します。

databricks postgres delete-role projects/my-project-id/branches/my-branch-id/roles/my-role

databricks postgres generate-database-credential

Postgres データベースの OAuth 資格情報を生成します。 返された OAuth トークンは、認証を行い、 psqlなどの PostgreSQL クライアントを使用してデータベースに接続するために使用されます。

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

databricks postgres get-branch

ブランチを取得します。

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 get-endpoint

エンドポイントを取得します。

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 get-operation

操作を取得します。

databricks postgres get-operation NAME [flags]

論争

NAME

    操作リソースの名前。

オプション

グローバル フラグ

例示

次の例では、操作に関する情報を取得します。

databricks postgres get-operation projects/my-project-id/operations/my-operation-id

databricks postgres get-project

プロジェクトを取得します。

databricks postgres get-project NAME [flags]

論争

NAME

    取得するプロジェクトの名前。 形式: projects/{project_id}

オプション

グローバル フラグ

例示

次の例では、プロジェクトに関する情報を取得します。

databricks postgres get-project projects/my-project-id

databricks postgres get-role

ブランチの Postgres ロールを取得します。 認証方法やアクセス許可など、指定したロールに関する情報を取得します。

databricks postgres get-role NAME [flags]

論争

NAME

    取得するロールの完全なリソース パス。 形式: projects/{project_id}/branches/{branch_id}/roles/{role_id}.

オプション

グローバル フラグ

例示

次の例では、ロールを取得します。

databricks postgres get-role projects/my-project-id/branches/my-branch-id/roles/my-role

databricks postgres list-branchs

ブランチを一覧表示します。 このコマンドを使用して、プロジェクトで作成された既定のブランチ (状態 "default": true で示されます) を含むブランチ ID を検索します。

databricks postgres list-branches PARENT [flags]

論争

PARENT

    このブランチのコレクションを所有する Project。 形式: 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 list-endpoints

エンドポイントを一覧表示します。 このコマンドを使用して、プロジェクトで自動的に作成される既定の読み取り/書き込みエンドポイントなど、エンドポイント ID を検索します。

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 list-projects

プロジェクトの一覧を表示します。

databricks postgres list-projects [flags]

オプション

--limit int

    返される結果の最大数。

--page-size int

    返される項目の上限。

--page-token string

    前の応答のページ トークン。

--show-deleted

    論理的に削除されたプロジェクトを応答に含めるかどうか。

グローバル フラグ

例示

次の例では、すべてのプロジェクトを一覧表示します。

databricks postgres list-projects

次の例では、改ページ位置が設定されたプロジェクトの一覧を示します。

databricks postgres list-projects --page-size 10

次の例では、論理的に削除されたプロジェクトを含むすべてのプロジェクトを一覧表示します。

databricks postgres list-projects --show-deleted

databricks postgres list-roles

ブランチの Postgres ロールを一覧表示します。

databricks postgres list-roles PARENT [flags]

論争

PARENT

    ロールのこのコレクションを所有するブランチ。 形式: projects/{project_id}/branches/{branch_id}.

オプション

--page-size int

    返される項目の上限。

--page-token string

    前の応答のページ トークン。

グローバル フラグ

例示

次の例では、ブランチ内のすべてのロールを一覧表示します。

databricks postgres list-roles projects/my-project-id/branches/my-branch-id

databricks postgres undelete-project

Projectの削除を取り消します。

注

これは実行時間の長い操作です。 既定では、コマンドは操作の完了を待機します。 --no-waitを使用して、未加工の操作の詳細をすぐに返します。 その後、操作の name フィールドを使用して、 get-operation コマンドを使用して完了をポーリングできます。

databricks postgres undelete-project NAME [flags]

論争

NAME

    削除を取り消すプロジェクトの完全なリソース パス。 形式: projects/{project_id}

オプション

--no-wait

    DONE 状態になるまで待つ必要はありません。

--timeout duration

    DONE 状態に達するまでの最大時間。

グローバル フラグ

例示

次の例では、論理的に削除されたプロジェクトを回復します。

databricks postgres undelete-project projects/my-project-id

databricks postgres update-branch

ブランチを更新します。

注

これは実行時間の長い操作です。 既定では、コマンドは操作の完了を待機します。 --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 update-endpoint

エンドポイントを更新します。

注

これは実行時間の長い操作です。 既定では、コマンドは操作の完了を待機します。 --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
    }
  }'

スケールをゼロに構成するには、更新マスクに spec.suspension を含めます。 suspend_timeout_duration (60 ~ 604800) を設定して非アクティブ タイムアウトを定義するか、無効にするno_suspension: trueします。 両方を設定しないでください。 no_suspension: falseを設定すると、エラーが返されます。

次の例では、ゼロへのスケールを無効にします。

databricks postgres update-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id spec.suspension \
  --json '{
    "spec": {
      "no_suspension": true
    }
  }'

次の例では、5 分間の非アクティブ タイムアウトでゼロにスケーリングできます。

databricks postgres update-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id spec.suspension \
  --json '{
    "spec": {
      "suspend_timeout_duration": "300s"
    }
  }'

databricks postgres update-project

プロジェクトを更新します。

注

これは実行時間の長い操作です。 既定では、コマンドは操作の完了を待機します。 --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"
    }
  }'

databricks postgres update-role

ブランチの Postgres ロールを更新します。

注

これは実行時間の長い操作です。 既定では、コマンドは操作の完了を待機します。 --no-waitを使用して、未加工の操作の詳細をすぐに返します。 その後、操作の name フィールドを使用して、 get-operation コマンドを使用して完了をポーリングできます。

databricks postgres update-role NAME UPDATE_MASK [flags]

論争

NAME

    ロールの完全なリソース パス。 形式: projects/{project_id}/branches/{branch_id}/roles/{role_id}.

UPDATE_MASK

    更新するフィールドの一覧。 指定しない場合は、可能な限りすべてのフィールドが更新されます。

オプション

--json JSON

    要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。

--name string

    ロールのリソース名 (出力のみ)。

--no-wait

    DONE 状態に達するまで待つ必要はありません。

--timeout duration

    DONE 状態に達するまでの最大時間。

グローバル フラグ

例示

次の例では、ロールに CREATEDB を許可します。 spec.attributesを更新するときは、次の 3 つの属性フィールドをすべて指定する必要があります。

databricks postgres update-role projects/my-project-id/branches/my-branch-id/roles/my-role \
  spec.attributes \
  --json '{"spec": {"attributes": {"createdb": true, "createrole": false, "bypassrls": false}}}'

次の例では、 databricks_superuser メンバーシップにロールを追加します。

databricks postgres update-role projects/my-project-id/branches/my-branch-id/roles/my-role \
  spec.membership_roles \
  --json '{"spec": {"membership_roles": ["DATABRICKS_SUPERUSER"]}}'

グローバル フラグ

--debug

  デバッグ ログを有効にするかどうかを指定します。

-h または --help

    Databricks CLI、または関連コマンド グループ、または関連コマンドのヘルプの表示。

--log-file 文字列

    出力ログを書き込むファイルを表す文字列。 このフラグが指定されていない場合、既定では stderr に出力ログが書き込まれます。

--log-format 形式

    ログ形式の種類、 text 、または json。 既定値は text です。

--log-level 文字列

    ログ形式レベルを表す文字列。 指定しない場合、ログ形式レベルは無効になります。

-o, --output 型

    コマンド出力の種類( text または json)。 既定値は text です。

-p, --profile 文字列

    コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。 このフラグが指定されていない場合は、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。

--progress-format 形式

    進行状況ログを表示する形式: default、 append、 inplace、または json

-t, --target 文字列

    該当する場合は、使用するバンドル ターゲット

  • Last updated on