psqlコマンド
この情報は、Databricks CLI バージョン 0.285 以降に適用されます。Databricks CLI はパブリック プレビュー段階です。
Databricks CLI使用には、使用状況データ プロビジョニングを含むDatabricksライセンスおよびDatabricksプライバシー通知が適用されます。
Databricks CLI内のpsqlコマンドを使用すると、PostgreSQL クライアントを使用して Lakebase Postgres データベースに接続できます。Lakebaseプロビジョニング インスタンスとLakebaseオートスケール プロジェクトの両方をサポートします。
データブリックス psql
Lakebase Postgresデータベースに接続します。このコマンドを実行するには、お使いのマシンにpsqlクライアントがインストールされている必要があります。
このコマンドには、接続失敗に対する自動再試行ロジックが含まれています。--max-retriesフラグを使用して再試行動作を設定できます。
databricks psql [TARGET] [flags] [-- PSQL_ARGS...]
議論
TARGET
接続先のターゲット。Lakebaseプロビジョニングの場合は、インスタンス名を指定します。 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オートスケールのプロジェクトID。
--provisioned
利用可能なデータベースの一覧表示時に、Lakebaseのプロビジョニング済みインスタンスのみを表示する。
例
次の例では、 Lakebaseプロビジョニング インスタンスに接続します。
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 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
該当する場合、使用するバンドルターゲット