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
CLI
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 |
Flow
Attribute
|
Definition |
Requirement |
cmdArgs: { url: "<string>" }
|
The JDBC database connection URL. See Using JDBC URL in Liquibase.
|
Required
|
cmdArgs: { default-catalog-name: "<string>" }
|
Name of the default catalog to use for the database
connection
|
Optional |
cmdArgs: { 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 |
cmdArgs: { driver: "<string>" }
|
The JDBC driver class
|
Optional |
cmdArgs: { driver-properties-file: "<string>" }
|
The JDBC driver properties file
|
Optional |
cmdArgs: { 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 |
cmdArgs: { 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 |
liquibase.properties
Attribute
|
Definition |
Requirement |
liquibase.command.url: <string>
liquibase.command.connect.url: <string>
|
The JDBC database connection URL. See Using JDBC URL in Liquibase.
|
Required
|
liquibase.command.defaultCatalogName: <string>
liquibase.command.connect.defaultCatalogName: <string>
|
Name of the default catalog to use for the database
connection
|
Optional |
liquibase.command.defaultSchemaName: <string>
liquibase.command.connect.defaultSchemaName: <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 |
liquibase.command.driver: <string>
liquibase.command.connect.driver: <string>
|
The JDBC driver class
|
Optional |
liquibase.command.driverPropertiesFile: <string>
liquibase.command.connect.driverPropertiesFile: <string>
|
The JDBC driver properties file
|
Optional |
liquibase.command.password: <string>
liquibase.command.connect.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 |
liquibase.command.username: <string>
liquibase.command.connect.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 |
JAVA_OPTS
Attribute
|
Definition |
Requirement |
JAVA_OPTS=-Dliquibase.command.url=<string>
JAVA_OPTS=-Dliquibase.command.connect.url=<string>
|
The JDBC database connection URL. See Using JDBC URL in Liquibase.
|
Required
|
JAVA_OPTS=-Dliquibase.command.defaultCatalogName=<string>
JAVA_OPTS=-Dliquibase.command.connect.defaultCatalogName=<string>
|
Name of the default catalog to use for the database
connection
|
Optional |
JAVA_OPTS=-Dliquibase.command.defaultSchemaName=<string>
JAVA_OPTS=-Dliquibase.command.connect.defaultSchemaName=<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 |
JAVA_OPTS=-Dliquibase.command.driver=<string>
JAVA_OPTS=-Dliquibase.command.connect.driver=<string>
|
The JDBC driver class
|
Optional |
JAVA_OPTS=-Dliquibase.command.driverPropertiesFile=<string>
JAVA_OPTS=-Dliquibase.command.connect.driverPropertiesFile=<string>
|
The JDBC driver properties file
|
Optional |
JAVA_OPTS=-Dliquibase.command.password=<string>
JAVA_OPTS=-Dliquibase.command.connect.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 |
JAVA_OPTS=-Dliquibase.command.username=<string>
JAVA_OPTS=-Dliquibase.command.connect.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 |
Environment variable
Attribute
|
Definition |
Requirement |
LIQUIBASE_COMMAND_URL=<string>
LIQUIBASE_COMMAND_CONNECT_URL=<string>
|
The JDBC database connection URL. See Using JDBC URL in Liquibase.
|
Required
|
LIQUIBASE_COMMAND_DEFAULT_CATALOG_NAME=<string>
LIQUIBASE_COMMAND_CONNECT_DEFAULT_CATALOG_NAME=<string>
|
Name of the default catalog to use for the database
connection
|
Optional |
LIQUIBASE_COMMAND_DEFAULT_SCHEMA_NAME=<string>
LIQUIBASE_COMMAND_CONNECT_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 |
LIQUIBASE_COMMAND_DRIVER=<string>
LIQUIBASE_COMMAND_CONNECT_DRIVER=<string>
|
The JDBC driver class
|
Optional |
LIQUIBASE_COMMAND_DRIVER_PROPERTIES_FILE=<string>
LIQUIBASE_COMMAND_CONNECT_DRIVER_PROPERTIES_FILE=<string>
|
The JDBC driver properties file
|
Optional |
LIQUIBASE_COMMAND_PASSWORD=<string>
LIQUIBASE_COMMAND_CONNECT_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 |
LIQUIBASE_COMMAND_USERNAME=<string>
LIQUIBASE_COMMAND_CONNECT_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 |
Connect Output Example
Copy
rberezenskyi@rberezenskyi:~/Downloads/liquibase-zip-master (2)$ ./liquibase connect
####################################################
## _ _ _ _ ##
## | | (_) (_) | ##
## | | _ __ _ _ _ _| |__ __ _ ___ ___ ##
## | | | |/ _` | | | | | '_ \ / _` / __|/ _ \ ##
## | |___| | (_| | |_| | | |_) | (_| \__ \ __/ ##
## \_____/_|\__, |\__,_|_|_.__/ \__,_|___/\___| ##
## | | ##
## |_| ##
## ##
## Get documentation at docs.liquibase.com ##
## Get certified courses at learn.liquibase.com ##
## ##
####################################################
Starting Liquibase at 11:21:05 (version [Core: liquibase/liquibase/master/1361/15bf69/2023-12-14 17:38:57 UTC, Pro: master/6362/23e309/2023-12-13 18:45:42] #1361 built at 2023-12-14 17:38:57 UTC)
Liquibase Version: [Core: liquibase/liquibase/master/1361/15bf69/2023-12-14 17:38:57 UTC, Pro: master/6362/23e309/2023-12-13 18:45:42]
Liquibase Pro [Core: liquibase/liquibase/master/1361/15bf69/2023-12-14 17:38:57 UTC, Pro: master/6362/23e309/2023-12-13 18:45:42] by Liquibase licensed to LB Internal Engineering License until Tue. Apr. 30 18:00:00 MDT 2024
Success: The database '(H2 2.2.224 (2023-09-17))' at url 'jdbc:h2:tcp://localhost:9090/mem:dev' is accessible with the supplied credentials.
Liquibase command 'connect' was executed successfully.