通过


psql 命令

注释

此信息适用于 Databricks CLI 版本 0.285 及更高版本。 Databricks CLI 目前处于公共预览阶段。

Databricks CLI 的使用须遵守 Databricks 许可Databricks 隐私声明,包括任何数据使用规定。

Databrickspsql CLI 中的命令允许使用 PostgreSQL 客户端连接到指定的数据库实例。

databricks psql

连接到指定的数据库实例。 此命令要求 psql 在计算机上安装客户端。

该命令包括连接失败的自动重试逻辑。 可以使用标志配置重试行为 --max-retries

databricks psql [DATABASE_INSTANCE_NAME] [-- PSQL_ARGS...] [flags]

Arguments

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 格式

    日志格式类型,textjson。 默认值为 text

--log-level 字符串

    一个表示日志格式级别的字符串。 如果未指定,则禁用日志格式级别。

-o, --output 类型

    命令输出类型为 textjson。 默认值为 text

-p, --profile 字符串

    要用于运行命令的 ~/.databrickscfg 文件中的配置文件名称。 如果未指定此标志,并且存在命名为 DEFAULT 的配置文件,则使用该配置文件。

--progress-format 格式

    显示进度日志的格式: defaultappendinplacejson

-t, --target 字符串

    如果适用,要使用的捆绑包目标