psql command

Note

This information applies to Databricks CLI versions 0.285 and above. The Databricks CLI is in Public Preview.

Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.

The psql command within the Databricks CLI allows you to connect to a specified database instance using a PostgreSQL client.

databricks psql

Connect to the specified database instance. This command requires a psql client to be installed on your machine.

The command includes automatic retry logic for connection failures. You can configure the retry behavior using the --max-retries flag.

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

Arguments

DATABASE_INSTANCE_NAME

    The name of the Database Instance to connect to.

PSQL_ARGS (optional)

    Additional arguments to pass to the psql client. Specify these after a double-dash (--) separator.

Options

--max-retries int

    Maximum number of connection retry attempts. Set to 0 to disable retries. Default: 3.

Global flags

Examples

The following example connects to a database instance:

databricks psql my-database

The following example connects to a database instance and executes a SQL query:

databricks psql my-database -- -c "SELECT * FROM my_table"

The following example connects with multiple psql options:

databricks psql my-database -- --echo-all -d "my-db"

The following example connects with custom retry behavior:

databricks psql my-database --max-retries 5

The following example connects with retries disabled:

databricks psql my-database --max-retries 0

Global flags

--debug

  Whether to enable debug logging.

-h or --help

    Display help for the Databricks CLI or the related command group or the related command.

--log-file string

    A string representing the file to write output logs to. If this flag is not specified then the default is to write output logs to stderr.

--log-format format

    The log format type, text or json. The default value is text.

--log-level string

    A string representing the log format level. If not specified then the log format level is disabled.

-o, --output type

    The command output type, text or json. The default value is text.

-p, --profile string

    The name of the profile in the ~/.databrickscfg file to use to run the command. If this flag is not specified then if it exists, the profile named DEFAULT is used.

--progress-format format

    The format to display progress logs: default, append, inplace, or json

-t, --target string

    If applicable, the bundle target to use