Liquibase Configuration Reference for Parameters and Environment Variables

Liquibase 4.4 and later versions can process configuration values from multiple sources.

The following table provides naming conventions of the Liquibase parameters for the liquibase.properties file, environment variables, and the CLI.

Check the related topics for more details when configuring Liquibase:

Tip: Additionally, you can run liquibase --help to see more specific information.

Global settings

alwaysOverrideStoredLogicSchema   Global

Properties string

liquibase.alwaysOverrideStoredLogicSchema

Environment variable

LIQUIBASE_ALWAYS_OVERRIDE_STORED_LOGIC_SCHEMA

CLI

--always-override-stored-logic-schema

Description

When generating SQL for createProcedure, the parameter defines whether the procedure schema should be forced to the default schema if no schemaName attribute is set.

autoReorg   Global

Properties string

liquibase.autoReorg

Environment variable

LIQUIBASE_AUTO_REORG

CLI

--auto-reorg

Description

The parameter defines whether Liquibase automatically reorganizes table objects stored on disk when you modify a DB2 database.

changelogLockPollRate   Global

Properties string

liquibase.changelogLockPollRate

Environment variable

LIQUIBASE_CHANGELOG_LOCK_POLL_RATE

CLI

--changelog-lock-poll-rate

Description

The parameter specifies the number of seconds Liquibase waits to check if a changelog lock has been released.

changeogLockWaitTimeInMinutes   Global

Properties string

liquibase.changeogLockWaitTimeInMinutes

Environment variable

LIQUIBASE_CHANGELOG_LOCK_WAIT_TIME_IN_MINUTES

CLI

--changelog-lock-wait-time-in-minutes

Description

The parameter specifies the amount of time Liquibase waits for a locked database to become available.

classpath   Global

Properties string

liquibase.classpath

Environment variable

LIQUIBASE_CLASSPATH

CLI

--classpath

Description

The parameter specifies additional classpath entries to use.

convertDataTypes   Global

Properties string

liquibase.convertDataTypes

Environment variable

LIQUIBASE_CONVERT_DATA_TYPES

CLI

--convert-data-types

Description

The parameter allows Liquibase to convert
data types such as int, bigint, timestamp, and clob to the standard data types.

databaseChangelogLockTableName   Global

Properties string

liquibase.databaseChangelogLockTableName

Environment variable

LIQUIBASE_DATABASE_CHANGELOG_LOCK_TABLE_NAME

CLI

--database-changelog-lock-table-name

 

Description

The parameter specifies the name of a table to use for tracking concurrent Liquibase usage.

databaseChangelogTableName   Global

Properties string

liquibase.databaseChangelogTableName

Environment variable

LIQUIBASE_DATABASE_CHANGELOG_TABLE_NAME

CLI

--database-changelog-table-name

 

Description

The parameter specifies the name of a table to use for a tracking change history.

databaseClass   Global

Properties string

liquibase.databaseClass

Environment variable

LIQUIBASE_DATABASE_CLASS

CLI

--database-class

 

Description

The parameter specifies the class to use for a Database implementation.

defaultlogger.level   Global

Properties string

liquibase.defaultlogger.level

Environment variable

LIQUIBASE_DEFAULTLOGGER_LEVEL

CLI

--defaultlogger-level

 

Description

The parameter specifies a default logging level.

defaultsFile   Global

Properties string

liquibase.defaultsFile

Environment variable

LIQUIBASE_DEFAULTS_FILE

CLI

--defaults-file

 

Description

The parameter specifies the file with default Liquibase properties.

diffColumnOrder   Global

Properties string

liquibase.diffColumnOrder

Environment variable

LIQUIBASE_DIFF_COLUMN_ORDER

CLI

--diff-column-order

 

Description

The parameter defines whether Liquibase compares the column order in a diff operation.

driver   Global

Properties string

liquibase.driver

Environment variable

LIQUIBASE_DRIVER

CLI

--driver

 

Description

The parameter specifies the database driver class.

driverPropertiesFile   Global

Properties string

liquibase.driverPropertiesFile

Environment variable

LIQUIBASE_DRIVER_PROPERTIES_FILE

CLI

--driver-properties-file

 

Description

The parameter specifies a file with driver-specific properties.

fileEncoding   Global

Properties string

liquibase.fileEncoding: ASCII

Environment variable

LIQUIBASE_FILE_ENCODING=ASCII

CLI

--file-encoding=ASCII

 

Description

The parameter defines the file encoding.

filterLogMessages   Global

Properties string

liquibase.filterLogMessages

Environment variable

LIQUIBASE_FILTER_LOG_MESSAGES

CLI

--filter-log-messages

 

Description

The parameter defines whether Liquibase filters log messages for potentially insecure data.

generateChangesetCreatedValues   Global

Properties string

liquibase.generateChangesetCreatedValues

Environment variable

LIQUIBASE_GENERATE_CHANGESET_CREATED_VALUES

CLI

--generate-changeset-created-values

 

Description

The parameter determines whether Liquibase adds timestamps to changesets in the changelog it generates when you run the diffChangeLog command and generateChangeLog command.

generatedChangesetIdsContainsDescription   Global

Properties string

liquibase.generatedChangesetIdsContainsDescription

Environment variable

LIQUIBASE_GENERATED_CHANGESET_IDS_CONTAINS_DESCRIPTION

CLI

--generated-changeset-ids-contains-description

 

Description

The parameter determines whether Liquibase includes changeset descriptions in changelogs generated with the generateChangeLog command in addition to changeset IDs.

headless   Global

Properties string

liquibase.headless

Environment variable

LIQUIBASE_HEADLESS

CLI

--headless

 

Description

The parameter can force Liquibase to run without access to the console for input and output.

hub.apiKey   Global

Properties string

liquibase.hub.apiKey

Environment variable

LIQUIBASE_HUB_API_KEY

CLI

--hub-api-key

 

Description

The parameter specifies Liquibase Hub API key for operations.

hub.logLevel   Global

Properties string

liquibase.hub.logLevel

Environment variable

LIQUIBASE_HUB_LOG_LEVEL

CLI

--hub-log-level

 

Description

The parameter specifies the log level for filtering log messages to send to Liquibase Hub during operations.

hub.mode   Global

Properties string

liquibase.hub.mode

Environment variable

LIQUIBASE_HUB_MODE

CLI

--hub-mode

 

Description

The parameter specifies the content to send to Liquibase Hub during operations. Values can be all, meta, or off.

hub.url   Global

Properties string

liquibase.hub.url

Environment variable

LIQUIBASE_HUB_URL

CLI

--hub-url

 

Description

The parameter specifies Liquibase Hub URL for operations.

includeCatalogInSpecification   Global

Properties string

liquibase.includeCatalogInSpecification

Environment variable

LIQUIBASE_INCLUDE_CATALOG_IN_SPECIFICATION

CLI

--include-catalog-in-specification

 

Description

The parameter defines whether Liquibase includes the catalog name when determining equality between the compared databases.

includeSystemClasspath   Global

Properties string

liquibase.includeSystemClasspath

Environment variable

LIQUIBASE_INCLUDE_SYSTEM_CLASSPATH

CLI

--include-system-classpath

 

Description

The parameter defines whether Liquibase includes the system classpath when resolving classes at runtime.

liquibaseCatalogName   Global

Properties string

liquibase.liquibaseCatalogName

Environment variable

LIQUIBASE_LIQUIBASE_CATALOG_NAME

CLI

--liquibase-catalog-name

 

Description

The parameter specifies the catalog to use for Liquibase objects.

liquibaseSchemaName   Global

Properties string

liquibase.liquibaseSchemaName

Environment variable

LIQUIBASE_LIQUIBASE_SCHEMA_NAME

CLI

--liquibase-schema-name

 

Description

The parameter specifies the schema to use for the creation of Liquibase objects, like the DATABASECHANGELOG and DATABASECHANGELOGLOCK tracking tables.

liquibaseTablespaceName   Global

Properties string

liquibase.liquibaseTablespaceName

Environment variable

LIQUIBASE_LIQUIBASE_TABLESPACE_NAME

CLI

--liquibase-tablespace-name

 

Description

The parameter specifies the tablespace Liquibase uses to store objects that are being deployed to your database.

logFile   Global

Properties string

liquibase.logFile

Environment variable

LIQUIBASE_LOG_FILE

CLI

--log-file

 

Description

The parameter sends logging messages of what Liquibase does during runtime to a file.

logLevel   Global

Properties string

liquibase.logLevel

Environment variable

LIQUIBASE_LOG_LEVEL

CLI

--log-level

 

Description

The parameter controls the amount of messages that are generated when running Liquibase commands.

outputFile   Global

Properties string

liquibase.outputFile

Environment variable

LIQUIBASE_OUTPUT_FILE

CLI

--output-file

 

Description

The parameter sends your command output to a file.

outputFileEncoding   Global

Properties string

liquibase.outputFileEncoding

Environment variable

LIQUIBASE_OUTPUT_FILE_ENCODING

CLI

--output-file-encoding

 

Description

The parameter determines which character encoding to use when writing Liquibase command outputs to external files.

outputLineSeparator   Global

Properties string

liquibase.outputLineSeparator

Environment variable

LIQUIBASE_OUTPUT_LINE_SEPARATOR

CLI

--output-line-separator

 

Description

The parameter specifies the string that separates lines in STDOUT.

pro.licenseKey   Global

Properties string

liquibase.pro.licenseKey

Environment variable

LIQUIBASE_PRO_LICENSE_KEY

CLI

--pro-license-key

 

Description

The parameter specifies Liquibase Pro license key that allows using all the functionality of Liquibase Community and Liquibase Pro.

pro.markUnusedNotDrop   Global

Properties string

liquibase.pro.markUnusedNotDrop

Environment variable

LIQUIBASE_PRO_MARK_UNUSED_NOT_DROP

CLI

--pro-mark-unused-not-drop

 

Description

The parameter defines whether a column will be dropped in diffChangeLog.

pro.sql.inline   Global

Properties string

liquibase.pro.sql.inline

Environment variable

LIQUIBASE_PRO_SQL_INLINE

CLI

--pro-sql-inline

 

Description

The parameter generates changesets with SQL-based changes embedded instead of saving them to an external file if the value is set to true.

pro.synonyms.drop.public   Global

Properties string

liquibase.pro.synonyms.drop.public

Environment variable

LIQUIBASE_PRO_SYNONYMS_DROP_PUBLIC

CLI

--pro-synonyms-drop-public

 

Description

The parameter does not drop public synonyms in diffChangeLog or dropAll if the value is set to false.

propertyProviderClass   Global

Properties string

liquibase.propertyProviderClass

Environment variable

LIQUIBASE_PROPERTY_PROVIDER_CLASS

CLI

--property-provider-class

 

Description

The parameter implements the Properties class to provide additional driver properties.

shouldRun   Global

Properties string

liquibase.shouldRun

Environment variable

LIQUIBASE_SHOULD_RUN

CLI

--should-run

 

Description

The parameter determines whether Liquibase commands should run.

shouldSnapshotData   Global

Properties string

liquibase.shouldSnapshotData

Environment variable

LIQUIBASE_SHOULD_SNAPSHOT_DATA

CLI

--should-snapshot-data

 

Description

The parameter allows Liquibase to snapshot your database data.

supportPropertyEscaping   Global

Properties string

liquibase.supportPropertyEscaping

Environment variable

LIQUIBASE_SUPPORT_PROPERTY_ESCAPING

CLI

--support-property-escaping

 

Description

The parameter supports escaping changelog parameters using a colon. Example: ${:user.name}

useProcedureSchema   Global

Properties string

liquibase.useProcedureSchema

Environment variable

LIQUIBASE_USE_PROCEDURE_SCHEMA

CLI

--use-procedure-schema

 

Description

If the parameter is set to true, which is the default value, the createProcedure tags with a set schemaName will modify the procedure body with the given schema name.

Command settings

changeExecListenerClass   Command

Properties string

liquibase.command.changeExecListenerClass

Environment variable

LIQUIBASE_COMMAND_CHANGE_EXEC_LISTENER_CLASS

CLI

--change-exec-listener-class

 

Description

The parameter includes a fully-qualified class which specifies ChangeExecListener.

changeExecListenerPropertiesFile   Command

Properties string

liquibase.command.changeExecListenerPropertiesFile

Environment variable

LIQUIBASE_COMMAND_CHANGE_EXEC_LISTENER_PROPERTIES_FILE

CLI

--change-exec-listener-properties-file

 

Description

The parameter specifies the path to a properties file for ChangeExecListenerClass.

changelogFile   Command

Properties string

liquibase.command.changelogFile

Environment variable

LIQUIBASE_COMMAND_CHANGELOG_FILE

CLI

--changelog-file

 

Description

The parameter specifies the root changelog file to execute.

changesetIdentifier   Command

Properties string

liquibase.command.changesetIdentifier

Environment variable

LIQUIBASE_COMMAND_CHANGESET_IDENTIFIER

CLI

--changeset-identifier

 

Description

The parameter specifies the changeset ID identifier of the form filepath::id::author.

contexts   Command

Properties string

liquibase.command.contexts

Environment variable

LIQUIBASE_COMMAND_CONTEXTS

CLI

--contexts

 

Description

The parameter specifies the changeset contexts to match. Contexts in Liquibase are expressions you can add to changesets to control which will be executed in any particular migration run.

count   Command

Properties string

liquibase.command.count

Environment variable

LIQUIBASE_COMMAND_COUNT

CLI

--count

 

Description

The parameter specifies the number of changes for which to generate SQL.

dataOutputDirectory   Command

Properties string

liquibase.command.dataOutputDirectory

Environment variable

LIQUIBASE_COMMAND_DATA_OUTPUT_DIRECTORY

CLI

--data-output-directory

 

Description

The parameter specifies the directory to which Liquibase writes a table data.

date   Command

Properties string

liquibase.command.date

Environment variable

LIQUIBASE_COMMAND_DATE

CLI

--date

 

Description

The parameter specifies the date to which Liquibase can roll back changes.

defaultCatalogName   Command

Properties string

liquibase.command.defaultCatalogName

Environment variable

LIQUIBASE_COMMAND_DEFAULT_CATALOG_NAME

CLI

--default-catalog-name

 

Description

The parameter specifies the default catalog name to use for the database connection.

defaultSchemaName   Command

Properties string

liquibase.command.defaultSchemaName

Environment variable

LIQUIBASE_COMMAND_DEFAULT_SCHEMA_NAME

CLI

--default-schema-name

 

Description

The parameter specifies the default schema name to use for the database connection.

delimiter   Command

Properties string

liquibase.command.delimiter

Environment variable

LIQUIBASE_COMMAND_DELIMITER

CLI

--delimiter

 

Description

The parameter specifies the delimiter to use when executing the SQL script.

diffTypes   Command

Properties string

liquibase.command.diffTypes

Environment variable

LIQUIBASE_COMMAND_DIFF_TYPES

CLI

--diff-types

 

Description

The parameter specifies types of objects to compare.

driver   Command

Properties string

liquibase.command.driver

Environment variable

LIQUIBASE_COMMAND_DRIVER

CLI

--driver

 

Description

The parameter specifies the JDBC driver class.

driverPropertiesFile   Command

Properties string

liquibase.command.driverPropertiesFile

Environment variable

LIQUIBASE_COMMAND_DRIVER_PROPERTIES_FILE

CLI

--driver-properties-file

 

Description

The parameter specifies the JDBC driver properties file.

excludeObjects   Command

Properties string

liquibase.command.excludeObjects

Environment variable

LIQUIBASE_COMMAND_EXCLUDE_OBJECTS

CLI

--exclude-objects

 

Description

The parameter specifies objects to exclude from the diff operation.

hubConnectionId   Command

Properties string

liquibase.command.hubConnectionId

Environment variable

LIQUIBASE_COMMAND_HUB_CONNECTION_ID

CLI

--hub-connection-id

 

Description

The parameter identifies the specific target in which to record your data at Liquibase Hub. The parameter is available in your Project at https://hub.liquibase.com.

hubProjectId   Command

Properties string

liquibase.command.hubProjectId

Environment variable

LIQUIBASE_COMMAND_HUB_PROJECT_ID

CLI

--hub-project-id

 

Description

The parameter identifies the specific Project in which to record your data at Liquibase Hub. The parameter is available in your account at https://hub.liquibase.com.

hubProjectName   Command

Properties string

liquibase.command.hubProjectName

Environment variable

LIQUIBASE_COMMAND_HUB_PROJECT_NAME

CLI

--hub-project-name

 

Description

The parameter specifies the Liquibase Hub project name.

includeObjects   Command

Properties string

liquibase.command.includeObjects

Environment variable

LIQUIBASE_COMMAND_INCLUDE_OBJECTS

CLI

--include-objects

 

Description

The parameter specifies objects to include in the diff operation.

labels   Command

Properties string

liquibase.command.labels

Environment variable

LIQUIBASE_COMMAND_LABELS

CLI

--labels

 

Description

The parameter specifies the changeset labels to match. Labels in Liquibase are tags that you can add to changesets to control which changeset will be executed in any migration run.

outputDirectory   Command

Properties string

liquibase.command.outputDirectory

Environment variable

LIQUIBASE_COMMAND_OUTPUT_DIRECTORY

CLI

--output-directory

 

Description

The parameter specifies the directory where the documentation is generated.

overwriteOutputFile   Command

Properties string

liquibase.command.overwriteOutputFile

Environment variable

LIQUIBASE_COMMAND_OVERWRITE_OUTPUT_FILE

CLI

--overwrite-output-file

 

Description

The parameter allows you to overwrite the output changelog file.

password   Command

Properties string

liquibase.command.password

Environment variable

LIQUIBASE_COMMAND_PASSWORD

CLI

--password

 

Description

The parameter specifies the password to use for connection to the target database.

referenceDefaultCatalogName   Command

Properties string

liquibase.command.referenceDefaultCatalogName

Environment variable

LIQUIBASE_COMMAND_REFERENCE_DEFAULT_CATALOG_NAME

CLI

--reference-default-catalog-name

 

Description

The parameter specifies the default catalog name to use for the reference database connection.

referenceDefaultSchemaName   Command

Properties string

liquibase.command.referenceDefaultSchemaName

Environment variable

LIQUIBASE_COMMAND_REFERENCE_DEFAULT_SCHEMA_NAME

CLI

--reference-default-schema-name

 

Description

The parameter specifies the default schema name to use for the reference database connection.

referencePassword   Command

Properties string

liquibase.command.referencePassword

Environment variable

LIQUIBASE_COMMAND_REFERENCE_PASSWORD

CLI

--reference-password

 

Description

The parameter specifies the password to use for connection to the reference database.

referenceUrl   Command

Properties string

liquibase.command.referenceUrl

Environment variable

LIQUIBASE_COMMAND_REFERENCE_URL

CLI

--reference-url

 

Description

The parameter specifies the JDBC reference database connection URL.

referenceUsername   Command

Properties string

liquibase.command.referenceUsername

Environment variable

LIQUIBASE_COMMAND_REFERENCE_USERNAME

CLI

--reference-username

 

Description

The parameter specifies the username to use for connection to the reference database.

rollbackScript   Command

Properties string

liquibase.command.rollbackScript

Environment variable

LIQUIBASE_COMMAND_ROLLBACK_SCRIPT

CLI

--rollback-script

 

Description

The parameter specifies the rollback script to execute.

schemas   Command

Properties string

liquibase.command.schemas

Environment variable

LIQUIBASE_COMMAND_SCHEMAS

CLI

--schemas

 

Description

The parameter specifies schemas to include in the diff operation.

snapshotFormat   Command

Properties string

liquibase.command.snapshotFormat

Environment variable

LIQUIBASE_COMMAND_SNAPSHOT_FORMAT

CLI

--snapshot-format

 

Description

The parameter specifies the output format to use for a snapshot (JSON or YAML).

sql   Command

Properties string

liquibase.command.sql

Environment variable

LIQUIBASE_COMMAND_SQL

CLI

--sql

 

Description

The parameter specifies the SQL string to execute.

sqlFile   Command

Properties string

liquibase.command.sqlFile

Environment variable

LIQUIBASE_COMMAND_SQL_FILE

CLI

--sql-file

 

Description

The parameter specifies the file where SQL statements are stored.

tag   Command

Properties string

liquibase.command.tag

Environment variable

LIQUIBASE_COMMAND_TAG

CLI

--tag

 

Description

The parameter specifies the tag to which Liquibase can generate SQL.

url   Command

Properties string

liquibase.command.url

Environment variable

LIQUIBASE_COMMAND_URL

CLI

--url

 

Description

The parameter specifies the JDBC database connection URL.

username   Command

Properties string

liquibase.command.username

Environment variable

LIQUIBASE_COMMAND_USERNAME

CLI

--username

 

Description

The parameter specifies the username to use for connection to the target database.

verbose   Command

Properties string

liquibase.command.verbose

Environment variable

LIQUIBASE_COMMAND_VERBOSE

CLI

--verbose

 

Description

The parameter specifies the verbose flag which provides additional details.