注
この情報は、Databricks CLI バージョン 0.285 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
Databricks CLI 内の psql コマンドを使用すると、PostgreSQL クライアントを使用して、指定したデータベース インスタンスに接続できます。
databricks psql
指定したデータベース インスタンスに接続します。 このコマンドを実行するには、 psql クライアントをコンピューターにインストールする必要があります。
このコマンドには、接続エラーの自動再試行ロジックが含まれています。
--max-retries フラグを使用して再試行動作を構成できます。
databricks psql [DATABASE_INSTANCE_NAME] [-- PSQL_ARGS...] [flags]
論争
DATABASE_INSTANCE_NAME
接続先のデータベース インスタンスの名前。
PSQL_ARGS (任意)
psql クライアントに渡す追加の引数。 二重ダッシュ (--) 区切り記号の後にこれらを指定します。
オプション
--max-retries int
接続の再試行の最大数。 再試行を無効にするには、 0 に設定します。 既定値: 3。
例示
次の例では、データベース インスタンスに接続します。
databricks psql my-database
次の例では、データベース インスタンスに接続し、SQL クエリを実行します。
databricks psql my-database -- -c "SELECT * FROM my_table"
次の例では、複数の psql オプションを使用して接続します。
databricks psql my-database -- --echo-all -d "my-db"
次の例では、カスタム再試行動作に接続します。
databricks psql my-database --max-retries 5
次の例では、再試行を無効にして接続します。
databricks psql my-database --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 文字列
該当する場合は、使用するバンドル ターゲット