備註
此資訊適用於 Databricks CLI 版本 0.285 及以上版本。
Databricks CLI 的使用受限於 Databricks 授權 和 Databricks 隱私權聲明，包括任何使用數據條款。
psql
Databricks CLI 中的指令允許你使用 PostgreSQL 用戶端連接到 Lakebase Postgres 資料庫。 它支援 Lakebase Provisioned 實例與 Lakebase 自動擴展專案。
Databricks PSQL
連接到 Lakebase Postgres 資料庫。 此指令需要在您的機器上安裝客戶 psql 端。
此指令包含連線失敗的自動重試邏輯。 你可以用旗 --max-retries 標設定重試行為。
databricks psql [TARGET] [flags] [-- PSQL_ARGS...]
Arguments
TARGET
要連結的目標。 對於 Lakebase Provisioned，請指定實例名稱。 對於 Lakebase 自動縮放，請以 的形式指定完整路徑 projects/<project>/branches/<branch>/endpoints/<endpoint>。 若省略，指令會列出可供互動選擇的資料庫。
PSQL_ARGS (選用)
還有額外的論點要交給 psql 客戶。 在雙段劃--分符（）後指定這些。
選項
--autoscaling
只有在列出可用資料庫時才顯示 Lakebase 自動縮放專案。
--branch string
Lakebase 自動縮放的分支 ID。 當只有一個分支存在時，預設會自動選擇。
--endpoint string
Lakebase 自動縮放的端點識別碼。 當只有一個端點存在時，預設會自動選擇。
--max-retries int
連線重試次數上限。 設定為 0 以停用重試。 預設值：3。
--project string
Project ID 用於 Lakebase 自動縮放。
--provisioned
僅在列出可用資料庫時顯示 Lakebase Provisioned 實例。
範例
以下範例連接至 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、、appendinplace、 或json
-t, --target 字串
如果適用，要使用的套件組合目標