`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，该 ID 将成为分支资源名称的最终组件。长度必须为 1-63 个字符，以小写字母开头，并且仅包含小写字母、数字和连字符（RFC 1123）。

选项

--json JSON

内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。

--name string

分支的资源名称。

--no-wait

不要等到“完成”状态。

--timeout duration

达到 DONE 状态的最长时间。

全局标志

例子

以下示例在项目中创建分支：

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，该 ID 将成为终结点资源名称的最终组件。长度必须为 1-63 个字符，以小写字母开头，并且仅包含小写字母、数字和连字符（RFC 1123）。

选项

--json JSON

内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。

--name string

终结点的资源名称。

--no-wait

不要等到“完成”状态。

--timeout duration

达到 DONE 状态的最长时间。

全局标志

例子

以下示例在分支中创建读写终结点：

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 字符串或包含请求正文的 JSON 文件中的 @path。

--name string

项目的资源名称。

--no-wait

不要等到“完成”状态。

--timeout duration

达到 DONE 状态的最长时间。

全局标志

例子

以下示例创建一个项目：

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

删除分支。

注释

无法删除受保护的分支。用于在删除之前设置为 />。

databricks postgres delete-branch NAME [flags]

Arguments

NAME

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

选项

--no-wait

不要等到“完成”状态。

--timeout duration

达到 DONE 状态的最长时间。

全局标志

例子

以下示例删除分支：

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

达到 DONE 状态的最长时间。

全局标志

例子

以下示例删除终结点：

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

达到 DONE 状态的最长时间。

全局标志

例子

以下示例删除项目：

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

databricks postgres generate-database-credential

为 Postgres 数据库生成 OAuth 凭据。返回的 OAuth 令牌用于使用 PostgreSQL 客户端（例如 psql）进行身份验证并连接到数据库。

databricks postgres generate-database-credential ENDPOINT [flags]

Arguments

ENDPOINT

为其生成此凭据的终结点。格式：projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

选项

--json JSON

内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。

全局标志

例子

以下示例为终结点生成 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 字符串或包含请求正文的 JSON 文件中的 @path。

--name string

分支的资源名称。

--no-wait

不要等到“完成”状态。

--timeout duration

达到 DONE 状态的最长时间。

全局标志

例子

以下示例更新分支以使其受到保护：

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 字符串或包含请求正文的 JSON 文件中的 @path。

--name string

终结点的资源名称。

--no-wait

不要等到“完成”状态。

--timeout duration

达到 DONE 状态的最长时间。

全局标志

例子

以下示例更新终结点的最大计算单位：

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 字符串或包含请求正文的 JSON 文件中的 @path。

--name string

项目的资源名称。

--no-wait

不要等到“完成”状态。

--timeout duration

达到 DONE 状态的最长时间。

全局标志

例子

以下示例更新项目的显示名称：

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、 append、 inplace或 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 generate-database-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` 命令组