`postgres` 命令群組

備註

此資訊適用於 Databricks CLI 版本 0.285 及以上版本。 Databricks CLI 處於公開預覽狀態。

Databricks CLI 的使用受限於 Databricks 授權和 Databricks 隱私權聲明，包括任何使用數據條款。

postgres Databricks CLI 中的指令群組包含管理 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]

Arguments

PARENT

這個分支成立的專案。格式：projects/{project_id}

BRANCH_ID

用於分支的 ID，成為分支資源名稱的最後一個組件。必須長度為 1 到 63 個字元，以小寫字母開頭，且僅包含小寫字母、數字及連字號（RFC 1123）。

選項

--json JSON

內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

--name string

分支的資源名稱。

--no-wait

不要等到完成狀態。

--timeout duration

達到完成狀態的最長時間。

全域旗標

範例

以下範例在專案中建立分支：

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

建立一個端點。一個分支可以有一個讀寫運算端點，以及多個唯讀端點（讀取副本），以擴展讀取操作。

備註

databricks postgres create-endpoint PARENT ENDPOINT_ID [flags]

Arguments

PARENT

建立這個端點的分支。格式：projects/{project_id}/branches/{branch_id}

ENDPOINT_ID

用於端點的 ID，成為端點資源名稱的最後一個元件。必須長度為 1 到 63 個字元，以小寫字母開頭，且僅包含小寫字母、數字及連字號（RFC 1123）。

選項

--json JSON

內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

--name string

端點的資源名稱。

--no-wait

不要等到完成狀態。

--timeout duration

達到完成狀態的最長時間。

全域旗標

範例

以下範例在分支中建立一個讀寫端點：

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

建立一個專案。

備註

當你建立專案時，它會自動包含預設的生產分支和一個讀寫計算端點，兩者都有自動產生的 ID。

databricks postgres create-project PROJECT_ID [flags]

Arguments

PROJECT_ID

專案使用的 ID，成為專案資源名稱的最終元件。必須長度為 1 到 63 個字元，以小寫字母開頭，且僅包含小寫字母、數字及連字號（RFC 1123）。

選項

--json JSON

內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

--name string

專案的資源名稱。

--no-wait

不要等到完成狀態。

--timeout duration

達到完成狀態的最長時間。

全域旗標

範例

以下範例建立一個專案：

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 Delete-branch

刪除分支。

備註

受保護的分支無法被刪除。刪除前會spec.is_protected設定update-branch為 false 。

databricks postgres delete-branch NAME [flags]

Arguments

NAME

要刪除的分支名稱。格式：projects/{project_id}/branches/{branch_id}

選項

--no-wait

不要等到完成狀態。

--timeout duration

達到完成狀態的最長時間。

全域旗標

範例

以下範例刪除一個分支：

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

Databricks postgres delete-endpoint

刪除一個端點。

備註

databricks postgres delete-endpoint NAME [flags]

Arguments

NAME

要刪除的端點名稱。格式：projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

選項

--no-wait

不要等到完成狀態。

--timeout duration

達到完成狀態的最長時間。

全域旗標

範例

以下範例刪除了一個端點：

databricks postgres delete-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id

Databricks Postgres Delete-Project

刪除專案。

備註

databricks postgres delete-project NAME [flags]

Arguments

NAME

要刪除的專案名稱。格式：projects/{project_id}

選項

--no-wait

不要等到完成狀態。

--timeout duration

達到完成狀態的最長時間。

全域旗標

範例

以下範例刪除專案：

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

Databricks postgres 生成-資料庫-credential

為 Postgres 資料庫產生 OAuth 憑證。回傳的 OAuth 憑證用來驗證並連接到像 S 這類 psqlPostgreSQL 用戶端的資料庫。

databricks postgres generate-database-credential ENDPOINT [flags]

Arguments

ENDPOINT

此憑證產生的端點。格式：projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

選項

--json JSON

內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

範例

以下範例為端點產生 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]

Arguments

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]

Arguments

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]

Arguments

NAME

這個行動資源的名稱。

選項

全域旗標

範例

以下範例可取得操作相關資訊：

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

Databricks postgres Get-Project

找個專案。

databricks postgres get-project NAME [flags]

Arguments

NAME

要取回的計畫名稱。格式：projects/{project_id}

選項

全域旗標

範例

以下範例提供關於專案的資訊：

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

DataBricks Postgres list-branches

列表分支。使用此指令查找分支 ID，包括你專案中預設建立的分支（狀態中標示 "default": true ）。

databricks postgres list-branches PARENT [flags]

Arguments

PARENT

擁有這批分支的計畫。格式：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]

Arguments

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]

選項

--page-size int

傳回項目的上限。

--page-token string

來自先前回覆的頁面標記。

全域旗標

範例

以下範例列出所有專案：

databricks postgres list-projects

以下範例列出具有分頁的專案：

databricks postgres list-projects --page-size 10

Databricks Postgres Update-branch

更新分支。

備註

databricks postgres update-branch NAME UPDATE_MASK [flags]

Arguments

NAME

分支的資源名稱。格式：projects/{project_id}/branches/{branch_id}

UPDATE_MASK

要更新的欄位清單。若未指定欄位，則在可能的情況下更新所有欄位。

選項

--json JSON

內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

--name string

分支的資源名稱。

--no-wait

不要等到完成狀態。

--timeout duration

達到完成狀態的最長時間。

全域旗標

範例

以下範例更新分支以使其受到保護：

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

Databricks postgres update-endpoint

更新端點。

備註

databricks postgres update-endpoint NAME UPDATE_MASK [flags]

Arguments

NAME

端點的資源名稱。格式：projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

UPDATE_MASK

要更新的欄位清單。若未指定欄位，則在可能的情況下更新所有欄位。

選項

--json JSON

內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

--name string

端點的資源名稱。

--no-wait

不要等到完成狀態。

--timeout duration

達到完成狀態的最長時間。

全域旗標

範例

以下範例更新端點的最大運算單元：

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
    }
  }'

Databricks Postgres Update-project

更新專案。

備註

databricks postgres update-project NAME UPDATE_MASK [flags]

Arguments

NAME

專案的資源名稱。格式：projects/{project_id}

UPDATE_MASK

要更新的欄位清單。若未指定欄位，則在可能的情況下更新所有欄位。

選項

--json JSON

內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

--name string

專案的資源名稱。

--no-wait

不要等到完成狀態。

--timeout duration

達到完成狀態的最長時間。

全域旗標

範例

以下範例更新專案的顯示名稱：

databricks postgres update-project projects/my-project-id spec.display_name \
  --json '{
    "spec": {
      "display_name": "Updated Project Name"
    }
  }'

全域旗標

--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 字串

如果適用，要使用的套件組合目標

意見反應

此頁面對您有幫助嗎？

Last updated on 2026-02-07

共用方式為

postgres 命令群組

Databricks Postgres create-branch

Arguments

選項

範例

Databricks Postgres create-endpoint

Arguments

選項

範例

Databricks postgres create-project

Arguments

選項

範例

Databricks Postgres Delete-branch

Arguments

選項

範例

Databricks postgres delete-endpoint

Arguments

選項

範例

Databricks Postgres Delete-Project

Arguments

選項

範例

Databricks postgres 生成-資料庫-credential

Arguments

選項

範例

Databricks Postgres Get-branch

Arguments

選項

範例

Databricks Postgres Get-Endpoint

Arguments

選項

範例

Databricks postgres get-operation

Arguments

選項

範例

Databricks postgres Get-Project

Arguments

選項

範例

DataBricks Postgres list-branches

Arguments

選項

範例

Databricks postgres list-endpoints

Arguments

選項

範例

DataBricks Postgres list-projects

選項

範例

Databricks Postgres Update-branch

Arguments

選項

範例

Databricks postgres update-endpoint

Arguments

選項

範例

Databricks Postgres Update-project

Arguments

選項

範例

全域旗標

意見反應

其他資源

`postgres` 命令群組