注
この情報は、Databricks CLI バージョン 0.285 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
Databricks CLI 内の psql コマンドを使用すると、PostgreSQL クライアントを使用して Lakebase Postgres データベースに接続できます。 Lakebase プロビジョニング済みインスタンスと Lakebase 自動スケール プロジェクトの両方をサポートします。
databricks psql
Lakebase Postgres データベースに接続します。 このコマンドを実行するには、 psql クライアントをコンピューターにインストールする必要があります。
このコマンドには、接続エラーの自動再試行ロジックが含まれています。
--max-retries フラグを使用して再試行動作を構成できます。
databricks psql [TARGET] [flags] [-- PSQL_ARGS...]
論争
TARGET
接続先のターゲット。 Lakebase Provisioned の場合は、インスタンス名を指定します。 Lakebase 自動スケールの場合は、フォーム projects/<project>/branches/<branch>/endpoints/<endpoint>で完全なパスを指定します。 省略すると、対話型選択に使用できるデータベースが一覧表示されます。
PSQL_ARGS (任意)
psql クライアントに渡す追加の引数。 二重ダッシュ (--) 区切り記号の後にこれらを指定します。
オプション
--autoscaling
使用可能なデータベースを一覧表示する場合にのみ、Lakebase 自動スケーリング プロジェクトが表示されます。
--branch string
Lakebase 自動スケールのブランチ ID。 既定では、1 つのブランチのみが存在する場合に自動選択されます。
--endpoint string
Lakebase 自動スケールのエンドポイント ID。 既定では、1 つのエンドポイントのみが存在する場合に自動選択されます。
--max-retries int
接続の再試行の最大数。 再試行を無効にするには、 0 に設定します。 既定値: 3。
--project string
Lakebase 自動スケールのProject ID。
--provisioned
使用可能なデータベースを一覧表示する場合は、Lakebase プロビジョニング済みインスタンスのみを表示します。
例示
次の例では、Lakebase Provisioned インスタンスに接続します。
databricks psql my-instance
次の例では、フラグを使用して Lakebase 自動スケール プロジェクトに接続します。
databricks psql --project my-project --branch main --endpoint primary
次の例では、完全パスを使用して Lakebase 自動スケール プロジェクトに接続します。
databricks psql projects/my-project/branches/main/endpoints/primary
次の例では、対話型選択用の Lakebase 自動スケール プロジェクトのみを一覧表示します。
databricks psql --autoscaling
次の例では、 psql クライアントに追加の引数を渡します。
databricks psql my-instance -- -c "SELECT 1"
次の例では、再試行を無効にして接続します。
databricks psql my-instance --max-retries 0
グローバル フラグ
--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 文字列
該当する場合は、使用するバンドル ターゲット