注释
此信息适用于 Databricks CLI 版本 0.285 及更高版本。 Databricks CLI 目前处于公共预览阶段。
Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明，包括任何数据使用规定。
Databrickspsql CLI 中的命令允许使用 PostgreSQL 客户端连接到 Lakebase Postgres 数据库。 它支持 Lakebase 预配实例和 Lakebase 自动缩放项目。
databricks psql
连接到 Lakebase Postgres 数据库。 此命令要求 psql 在计算机上安装客户端。
该命令包括连接失败的自动重试逻辑。 可以使用标志配置重试行为 --max-retries 。
databricks psql [TARGET] [flags] [-- PSQL_ARGS...]
Arguments
TARGET
要连接到的目标。 对于已预配的 Lakebase，请指定实例名称。 对于 Lakebase 自动缩放，请指定表单 projects/<project>/branches/<branch>/endpoints/<endpoint>中的完整路径。 如果省略，命令将列出可用于交互式选择的数据库。
PSQL_ARGS（可选）
要传递给 psql 客户端的其他参数。 在双划线 （--） 分隔符后面指定这些值。
选项
--autoscaling
仅当列出可用数据库时显示 Lakebase 自动缩放项目。
--branch string
Lakebase 自动缩放的分支 ID。 当只有一个分支存在时，默认为自动选择。
--endpoint string
Lakebase 自动缩放的终结点 ID。 当只有一个终结点存在时，默认为自动选择。
--max-retries int
最大连接重试尝试次数。 设置为 0 禁用重试。 默认值：3。
--project string
Project 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 字符串
一个字符串，表示要将输出日志写入到的文件。 如果未指定此标志，则默认会将输出日志写入到 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 字符串
如果适用，要使用的捆绑包目标