connect

Note: This is a Liquibase Pro feature, so you need a Liquibase Pro License Key to use it.

The Liquibase connect command allows you to test access to the database without requiring the changelog. It is available in Liquibase 4.25.1 and later.

Uses

This allows the user to test the connection’s readiness prior to including project workflows while simultaneously separating connection troubleshooting from workflow troubleshooting. This command works similarly to the status and history commands if they were to operate without a changelog.

Syntax

To run the connect command, specify the user name, password, and URL in the CLI, defaults file, as an environment variable, or any other standard method.

Run the connect command:

liquibase connect

Command parameters

Attribute Definition Requirement

--url=<string>

The JDBC database connection URL. See Using JDBC URL in Liquibase.

Required

--default-catalog-name=<string>

Name of the default catalog to use for the database connection

Optional

--default-schema-name=<string>

Name of the default schema to use for the database connection. If defaultSchemaName is set, then objects do not have to be fully qualified. This means you can refer to just mytable instead of myschema.mytable.

Note: In the properties file and JAVA_OPTS only: in 4.18.0 and earlier, specify this parameter using the syntax defaultSchemaName. In 4.19.0 and later, use the syntax liquibase.command.defaultSchemaName.

Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set --preserve-schema-case to true. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a DatabaseException error if you specify a mixed-case value of defaultSchemaName. In 4.23.0 and later, the Liquibase validator accepts any casing.

Optional

--driver=<string>

The JDBC driver class

Optional

--driver-properties-file=<string>

The JDBC driver properties file

Optional

--password=<string>

Password to connect to the target database.

Tip: It is a best practice to store sensitive data in a Secrets Management tool with Liquibase Pro.

Optional

--username=<string>

Username to connect to the target database.

Tip: It is a best practice to store sensitive data in a Secrets Management tool with Liquibase Pro.

Optional