Liquibase Parameters

-h
--help

-v
--version

--allow-duplicated-changeset-identifiers
globalArgs: {allow-duplicated-changeset-identifiers: "val"}
liquibase.allowDuplicatedChangesetIdentifiers
LIQUIBASE_ALLOW_DUPLICATED_CHANGESET_IDENTIFIERS

--always-drop-instead-of-replace
globalArgs: {always-drop-instead-of-replace: "val"}
liquibase.alwaysDropInsteadOfReplace
LIQUIBASE_ALWAYS_DROP_INSTEAD_OF_REPLACE

--always-override-stored-logic-schema
globalArgs: {always-override-stored-logic-schema: "val"}
liquibase.alwaysOverrideStoredLogicSchema
LIQUIBASE_ALWAYS_OVERRIDE_STORED_LOGIC_SCHEMA

--analytics-enabled
globalArgs: {analytics-enabled: "val"}
liquibase.analyticsEnabled
LIQUIBASE_ANALYTICS_ENABLED

--analytics-log-level
globalArgs: {analytics-log-level: "val"}
liquibase.analyticsLogLevel
LIQUIBASE_ANALYTICS_LOG_LEVEL

--auto-reorg
globalArgs: {auto-reorg: "val"}
liquibase.autoReorg
LIQUIBASE_AUTO_REORG

--changelog-lock-poll-rate
globalArgs: {changelog-lock-poll-rate: "val"}
liquibase.changelogLockPollRate
LIQUIBASE_CHANGELOG_LOCK_POLL_RATE

--changelog-lock-wait-time-in-minutes
globalArgs: {changelog-lock-wait-time-in-minutes: "val"}
liquibase.changelogLockWaitTimeInMinutes
LIQUIBASE_CHANGELOG_LOCK_WAIT_TIME_IN_MINUTES

--changelog-parse-mode
globalArgs: {changelog-parse-mode: "val"}
liquibase.changelogParseMode
LIQUIBASE_CHANGELOG_PARSE_MODE

--classpath
globalArgs: {classpath: "val"}
liquibase.classpath
LIQUIBASE_CLASSPATH

Note: Liquibase uses the classpath to find all JARs in any location you specify except for extension JARs, such as the Liquibase extension for DynamoDB. Extension JARs included via classpath must go in one of the following locations: ./liquibase_libs, lib, internal/lib, or internal/extensions.

--convert-data-types
globalArgs: {convert-data-types: "val"}
liquibase.convertDataTypes
LIQUIBASE_CONVERT_DATA_TYPES

--database-changelog-lock-table-name
globalArgs: {database-changelog-lock-table-name: "val"}
liquibase.databaseChangelogLockTableName
LIQUIBASE_DATABASE_CHANGELOG_LOCK_TABLE_NAME

--database-changelog-table-name
globalArgs: {database-changelog-table-name: "val"}
liquibase.databaseChangelogTableName
LIQUIBASE_DATABASE_CHANGELOG_TABLE_NAME

--database-class
globalArgs: {database-class: "val"}
liquibase.databaseClass
LIQUIBASE_DATABASE_CLASS

--ddl-lock-timeout
globalArgs: {ddl-lock-timeout: "val"}
liquibase.ddlLockTimeout
LIQUIBASE_DDL_LOCK_TIMEOUT

--defaults-file
globalArgs: {defaults-file: "val"}
liquibase.defaultsFile
LIQUIBASE_DEFAULTS_FILE

--diff-column-order
globalArgs: {diff-column-order: "val"}
liquibase.diffColumnOrder
LIQUIBASE_DIFF_COLUMN_ORDER

--driver
globalArgs: {driver: "val"}
liquibase.driver
LIQUIBASE_DRIVER

--driver-properties-file
globalArgs: {driver-properties-file: "val"}
liquibase.driverPropertiesFile
LIQUIBASE_DRIVER_PROPERTIES_FILE

--duplicate-file-mode
globalArgs: {duplicate-file-mode: "val"}
liquibase.duplicateFileMode
LIQUIBASE_DUPLICATE_FILE_MODE

--error-on-circular-include-all
globalArgs: {error-on-circular-include-all: "val"}
liquibase.errorOnCircularIncludeAll
LIQUIBASE_ERROR_ON_CIRCULAR_INCLUDE_ALL

--file-encoding
globalArgs: {file-encoding: "val"}
liquibase.fileEncoding
LIQUIBASE_FILE_ENCODING

--generate-changeset-created-values
globalArgs: {generate-changeset-created-values: "val"}
liquibase.generateChangesetCreatedValues
LIQUIBASE_GENERATE_CHANGESET_CREATED_VALUES

--generated-changeset-ids-contains-description
globalArgs: {generated-changeset-ids-contains-description: "val"}
liquibase.generatedChangesetIdsContainsDescription
LIQUIBASE_GENERATED_CHANGESET_IDS_CONTAINS_DESCRIPTION

--headless
globalArgs: {headless: "val"}
liquibase.headless
LIQUIBASE_HEADLESS

--include-catalog-in-specification
globalArgs: {include-catalog-in-specification: "val"}
liquibase.includeCatalogInSpecification
LIQUIBASE_INCLUDE_CATALOG_IN_SPECIFICATION

--include-relations-for-computed-columns
globalArgs: {include-relations-for-computed-columns: "val"}
liquibase.includeRelationsForComputedColumns
LIQUIBASE_INCLUDE_RELATIONS_FOR_COMPUTED_COLUMNS

Specifies whether Liquibase commands like diff and snapshot preserve the parent relationship for computed columns. Default: false. Available in Liquibase 4.25.0+. See include-relations-for-computed-columns.

--include-system-classpath
globalArgs: {include-system-classpath: "val"}
liquibase.includeSystemClasspath
LIQUIBASE_INCLUDE_SYSTEM_CLASSPATH

--license-key
globalArgs: {license-key: "val"}
liquibase.licenseKey
LIQUIBASE_LICENSE_KEY

--liquibase-catalog-name
globalArgs: {liquibase-catalog-name: "val"}
liquibase.liquibaseCatalogName
LIQUIBASE_LIQUIBASE_CATALOG_NAME

--liquibase-schema-name
globalArgs: {liquibase-schema-name: "val"}
liquibase.liquibaseSchemaName
LIQUIBASE_LIQUIBASE_SCHEMA_NAME

--liquibase-tablespace-name
globalArgs: {liquibase-tablespace-name: "val"}
liquibase.liquibaseTablespaceName
LIQUIBASE_LIQUIBASE_TABLESPACE_NAME

--log-channels
globalArgs: {log-channels: "val"}
liquibase.logChannels
LIQUIBASE_LOG_CHANNELS

--log-file
globalArgs: {log-file: "val"}
liquibase.logFile
LIQUIBASE_LOG_FILE

--log-format
globalArgs: {log-format: "val"}
liquibase.logFormat
LIQUIBASE_LOG_FORMAT

Sets the format of log output to the console or to log files. Liquibase Open Source users default to unstructured TEXT logs to the console or output log files. Liquibase Pro users have the option to set the value as JSON or JSON_PRETTY to enable JSON-structured log files to the console or output log files. Default: TEXT. See log-format.

--log-level
globalArgs: {log-level: "val"}
liquibase.logLevel
LIQUIBASE_LOG_LEVEL

--mirror-console-messages-to-log
globalArgs: {mirror-console-messages-to-log: "val"}
liquibase.mirrorConsoleMessagesToLog
LIQUIBASE_MIRROR_CONSOLE_MESSAGES_TO_LOG

--mirror-output-to-console
globalArgs: {mirror-output-to-console: "val"}
liquibase.mirrorOutputToConsole
LIQUIBASE_MIRROR_OUTPUT_TO_CONSOLE

--missing-property-mode
globalArgs: {missing-property-mode: "val"}
liquibase.missingPropertyMode
LIQUIBASE_MISSING_PROPERTY_MODE

--monitor-performance
globalArgs: {monitor-performance: "val"}
liquibase.monitorPerformance
LIQUIBASE_MONITOR_PERFORMANCE

--on-missing-include-changelog
globalArgs: {on-missing-include-changelog: "val"}
liquibase.onMissingIncludeChangelog
LIQUIBASE_ON_MISSING_INCLUDE_CHANGELOG

--output-file
globalArgs: {output-file: "val"}
liquibase.outputFile
LIQUIBASE_OUTPUT_FILE

File path to where the command output will be written. If not specified, output goes to STDOUT. See --output-file.

--output-file-encoding
globalArgs: {output-file-encoding: "val"}
liquibase.outputFileEncoding
LIQUIBASE_OUTPUT_FILE_ENCODING

--output-line-separator
globalArgs: {output-line-separator: "val"}
liquibase.outputLineSeparator
LIQUIBASE_OUTPUT_LINE_SEPARATOR

--preserve-classpath-prefix-in-normalized-paths
globalArgs: {preserve-classpath-prefix-in-normalized-paths: "val"}
liquibase.preserveClasspathPrefixInNormalizedPaths
LIQUIBASE_PRESERVE_CLASSPATH_PREFIX_IN_NORMALIZED_PATHS

--preserve-schema-case
globalArgs: {preserve-schema-case: "val"}
liquibase.preserveSchemaCase
LIQUIBASE_PRESERVE_SCHEMA_CASE

--pro-global-end-delimiter
globalArgs: {pro-global-end-delimiter: "val"}
liquibase.pro.globalEndDelimiter
LIQUIBASE_PRO_GLOBAL_END_DELIMITER

Liquibase 4.25.1+. Specifies a default delimiter for all changesets. Default: ;. See pro-global-end-delimiter.

Tip: It is a best practice not to use --pro-global-end-delimiter on changesets you are running with a native executor. Native executors handle delimiters natively.

--pro-global-end-delimiter-prioritized
globalArgs: {pro-global-end-delimiter-prioritized: "val"}
liquibase.pro.globalEndDelimiter.prioritized
LIQUIBASE_PRO_GLOBAL_END_DELIMITER_PRIORITIZED

Liquibase 4.25.1+. Specifies whether the --pro-global-end-delimiter parameter always takes priority over other Liquibase delimiter settings. Default: false. See pro-global-end-delimiter-prioritized.

--pro-global-strip-comments
globalArgs: {pro-global-strip-comments: "val"}
liquibase.pro.globalStripComments
LIQUIBASE_PRO_GLOBAL_STRIP_COMMENTS

--pro-global-strip-comments-prioritized
globalArgs: {pro-global-strip-comments-prioritized: "val"}
liquibase.pro.globalStripComments.prioritized
LIQUIBASE_PRO_GLOBAL_STRIP_COMMENTS_PRIORITIZED

--pro-mark-unused-not-drop
globalArgs: {pro-mark-unused-not-drop: "val"}
liquibase.pro.markUnusedNotDrop
LIQUIBASE_PRO_MARK_UNUSED_NOT_DROP

--pro-sql-inline
globalArgs: {pro-sql-inline: "val"}
liquibase.pro.sql.inline
LIQUIBASE_PRO_SQL_INLINE

--pro-strict
globalArgs: {pro-strict: "val"}
liquibase.proStrict
LIQUIBASE_PRO_STRICT

--pro-synonyms-drop-public
globalArgs: {pro-synonyms-drop-public: "val"}
liquibase.pro.synonyms.drop.public
LIQUIBASE_PRO_SYNONYMS_DROP_PUBLIC

--prompt-for-non-local-database
globalArgs: {prompt-for-non-local-database: "val"}
liquibase.promptForNonLocalDatabase
LIQUIBASE_PROMPT_FOR_NON_LOCAL_DATABASE

--property-provider-class
globalArgs: {property-provider-class: "val"}
liquibase.propertyProviderClass
LIQUIBASE_PROPERTY_PROVIDER_CLASS

--search-path
globalArgs: {search-path: "val"}
liquibase.searchPath
LIQUIBASE_SEARCH_PATH

--secure-parsing
globalArgs: {secure-parsing: "val"}
liquibase.secureParsing
LIQUIBASE_SECURE_PARSING

--should-run
globalArgs: {should-run: "val"}
liquibase.shouldRun
LIQUIBASE_SHOULD_RUN

--should-snapshot-data
globalArgs: {should-snapshot-data: "val"}
liquibase.shouldSnapshotData
LIQUIBASE_SHOULD_SNAPSHOT_DATA

--show-banner
globalArgs: {show-banner: "val"}
liquibase.showBanner
LIQUIBASE_SHOW_BANNER

--sql-log-level
globalArgs: {sql-log-level: "val"}
liquibase.sql.logLevel
LIQUIBASE_SQL_LOG_LEVEL

--sql-show-sql-warnings
globalArgs: {sql-show-sql-warnings: "val"}
liquibase.sql.showSqlWarnings
LIQUIBASE_SQL_SHOW_SQL_WARNINGS

--strict
globalArgs: {strict: "val"}
liquibase.strict
LIQUIBASE_STRICT

--support-property-escaping
globalArgs: {support-property-escaping: "val"}
liquibase.supportPropertyEscaping
LIQUIBASE_SUPPORT_PROPERTY_ESCAPING

--supports-method-validation-level
globalArgs: {supports-method-validation-level: "val"}
liquibase.supportsMethodValidationLevel
LIQUIBASE_SUPPORTS_METHOD_VALIDATION_LEVEL

--suppress-liquibase-sql
globalArgs: {suppress-liquibase-sql: "val"}
liquibase.suppressLiquibaseSql
LIQUIBASE_SUPPRESS_LIQUIBASE_SQL

--trim-load-data-file-header
globalArgs: {trim-load-data-file-header: "val"}
liquibase.trimLoadDataFileHeader
LIQUIBASE_TRIM_LOAD_DATA_FILE_HEADER

--ui-service
globalArgs: {ui-service: "val"}
liquibase.uiService
LIQUIBASE_UI_SERVICE

--use-procedure-schema
globalArgs: {use-procedure-schema: "val"}
liquibase.useProcedureSchema
LIQUIBASE_USE_PROCEDURE_SCHEMA

--validate-xml-changelog-files
globalArgs: {validate-xml-changelog-files: "val"}
liquibase.validateXmlChangelogFiles
LIQUIBASE_VALIDATE_XML_CHANGELOG_FILES

--dbclhistory-capture-extensions
globalArgs: {dbclhistory-capture-extensions: "val"}
liquibase.dbclhistory.captureExtensions
LIQUIBASE_DBCLHISTORY_CAPTURE_EXTENSIONS

If true, installed extensions are captured in the DATABASECHANGELOGHISTORY table. Liquibase 4.27.0+. Default: true. See --dbclhistory-capture-extensions.

--dbclhistory-capture-sql
globalArgs: {dbclhistory-capture-sql: "val"}
liquibase.dbclhistory.captureSql
LIQUIBASE_DBCLHISTORY_CAPTURE_SQL

If true, SQL generated by commands is captured in the DATABASECHANGELOGHISTORY table. Liquibase 4.27.0+. Default: true. See --dbclhistory-capture-sql.

--dbclhistory-enabled
globalArgs: {dbclhistory-enabled: "val"}
liquibase.dbclhistory.enabled
LIQUIBASE_DBCLHISTORY_ENABLED

Enables the DATABASECHANGELOGHISTORY table. This table includes records of rollbacks, dropAlls, and repeated runOnChange type activity, which is not available in the standard DATABASECHANGELOG table. Liquibase 4.27.0+. Default: false. See --dbclhistory-enabled.

--dbclhistory-severity
globalArgs: {dbclhistory-severity: "val"}
liquibase.dbclhistory.severity
LIQUIBASE_DBCLHISTORY_SEVERITY

The exit code for Liquibase to return if an exception is encountered while recording events to the DATABASECHANGELOGHISTORY table. Valid values are INFO (0), MINOR (1), MAJOR (2), CRITICAL (3), and BLOCKER (4), from least severe to most severe. Liquibase 4.27.0+. Default: 1. See --dbclhistory-severity.

--psql-args
globalArgs: {psql-args: "val"}
liquibase.psql.args
LIQUIBASE_PSQL_ARGS

Defines extra arguments to pass to the psql executable. For more information, see PSQL documentation.

Note: The delimiter for arguments is a space " ". Do not use a comma "," or semicolon ";".

--psql-keep-temp
globalArgs: {psql-keep-temp: "val"}
liquibase.psql.keep.temp
LIQUIBASE_PSQL_KEEP_TEMP

Indicates whether or not to keep a temporary SQL file after the execution of PSQL. If true, the file is not deleted. This setting is not required to keep the temporary file, only create-spool is. Default: false.

--psql-keep-temp-name
globalArgs: {psql-keep-temp-name: "val"}
liquibase.psql.keep.temp.name
LIQUIBASE_PSQL_KEEP_TEMP_NAME

Indicates the name of a temporary SQL file after the execution of PSQL. If no file name is specified, a name is automatically generated.

--psql-keep-temp-path
globalArgs: {psql-keep-temp-path: "val"}
liquibase.psql.keep.temp.path
LIQUIBASE_PSQL_KEEP_TEMP_PATH

Specify the path in which to store the temporary files after the execution of PSQL. If not specified, the files will be stored in the system's temp directory.

--psql-log-file
globalArgs: {psql-log-file: "val"}
liquibase.psql.logFile
LIQUIBASE_PSQL_LOG_FILE

Log file for PSQL output.

--psql-path
globalArgs: {psql-path: "val"}
liquibase.psql.path
LIQUIBASE_PSQL_PATH

Path to psql executable. For example:

• Linux: /usr/pgsql-15/bin/psql
• Windows: C:\Program Files\PostgreSQL\15\bin\psql.exe

--psql-timeout
globalArgs: {psql-timeout: "val"}
liquibase.psql.timeout
LIQUIBASE_PSQL_TIMEOUT

Indicates seconds to wait for the psql timeout. -1 disables the timeout. 0 returns an error. Default: 1800 (30 minutes).

--sqlcmd-args
globalArgs: {sqlcmd-args: "val"}
liquibase.sqlcmd.args
LIQUIBASE_SQLCMD_ARGS

Defines extra arguments to pass to the sqlcmd executable. For more information, see sqlcmd Utility documentation.

Note: The delimiter for arguments is a space " ". Do not use a comma "," or semicolon ";".

--sqlcmd-catalog-name
globalArgs: {sqlcmd-catalog-name: "val"}
liquibase.sqlcmd.catalogName
LIQUIBASE_SQLCMD_CATALOG_NAME

Database to use when running SQLCMD.

--sqlcmd-keep-temp
globalArgs: {sqlcmd-keep-temp: "val"}
liquibase.sqlcmd.keep.temp
LIQUIBASE_SQLCMD_KEEP_TEMP

Indicates whether or not to keep a temporary SQL file after the execution of SQLCMD. If true, the file is not deleted. This setting is not required to keep the temporary file, only create-spool is. Default: false.

--sqlcmd-keep-temp-name
globalArgs: {sqlcmd-keep-temp-name: "val"}
liquibase.sqlcmd.keep.temp.name
LIQUIBASE_SQLCMD_KEEP_TEMP_NAME

Indicates the name of a temporary SQL file after the execution of SQLCMD. If no file name is specified, a name is automatically generated.

--sqlcmd-keep-temp-overwrite
globalArgs: {sqlcmd-keep-temp-overwrite: "val"}
liquibase.sqlcmd.keep.temp.overwrite
LIQUIBASE_SQLCMD_KEEP_TEMP_OVERWRITE

Overwrites any files in the specified directory with the same name. Default: true.

--sqlcmd-keep-temp-path
globalArgs: {sqlcmd-keep-temp-path: "val"}
liquibase.sqlcmd.keep.temp.path
LIQUIBASE_SQLCMD_KEEP_TEMP_PATH

Specify the path in which to store the temporary files after the execution of SQLCMD. If not specified, the files will be stored in the system's temp directory.

--sqlcmd-log-file
globalArgs: {sqlcmd-log-file: "val"}
liquibase.sqlcmd.logFile
LIQUIBASE_SQLCMD_LOG_FILE

Log file for SQLCMD output.

--sqlcmd-path
globalArgs: {sqlcmd-path: "val"}
liquibase.sqlcmd.path
LIQUIBASE_SQLCMD_PATH

Path to sqlcmd executable. For example:

• Linux: /opt/mssql-tools/bin/sqlcmd
• Windows: C:\Program Files\Microsoft SQL Server\Client SDK\ODBC\170\Tools\Binn\sqlcmd.exe

--sqlcmd-timeout
globalArgs: {sqlcmd-timeout: "val"}
liquibase.sqlcmd.timeout
LIQUIBASE_SQLCMD_TIMEOUT

Indicates seconds to wait for the sqlcmd timeout. -1 disables the timeout. 0 returns an error. Default: 1800 (30 minutes).

--sqlplus-args
globalArgs: {sqlplus-args: "val"}
liquibase.sqlplus.args
LIQUIBASE_SQLPLUS_ARGS

Defines extra arguments to pass to the sqlplus executable. For more information, see SQL Plus documentation.

Note: The delimiter for arguments is a space " ". Do not use a comma "," or semicolon ";".

--sqlplus-create-spool
globalArgs: {sqlplus-create-spool: "val"}
liquibase.sqlplus.createSpool
LIQUIBASE_SQLPLUS_CREATE_SPOOL

If true, create an Oracle spool file which captures the SQLPlus output. Default: true.
When create spool = false, the spool file does not generate.

--sqlplus-keep-temp
globalArgs: {sqlplus-keep-temp: "val"}
liquibase.sqlplus.keep.temp
LIQUIBASE_SQLPLUS_KEEP_TEMP

Indicates whether or not to keep a temporary SQL file after the execution of SQL Plus. If true, the file is not deleted. This setting is not required to keep the temporary file, only create-spool is. Default: false.

--sqlplus-keep-temp-name
globalArgs: {sqlplus-keep-temp-name: "val"}
liquibase.sqlplus.keep.temp.name
LIQUIBASE_SQLPLUS_KEEP_TEMP_NAME

Indicates the name of a temporary SQL file after the execution of SQL Plus. If no file name is specified, a name is automatically generated. In Oracle, if no file extension is specified, the file is saved as .lst.

--sqlplus-keep-temp-overwrite
globalArgs: {sqlplus-keep-temp-overwrite: "val"}
liquibase.sqlplus.keep.temp.overwrite
LIQUIBASE_SQLPLUS_KEEP_TEMP_OVERWRITE

Overwrites any files in the specified directory with the same name. Default: true.

--sqlplus-keep-temp-path
globalArgs: {sqlplus-keep-temp-path: "val"}
liquibase.sqlplus.keep.temp.path
LIQUIBASE_SQLPLUS_KEEP_TEMP_PATH

Specify the path in which to store the temporary files after the execution of SQL Plus. If not specified, the files will be stored in the system's temp directory.

--sqlplus-password
globalArgs: {sqlplus-password: "val"}
liquibase.sqlplus.password
LIQUIBASE_SQLPLUS_PASSWORD

Liquibase 4.29.2+. Password to use with the native executor, such as the password for an account with SYSDBA privileges. Liquibase will attempt to use the password exactly as entered.

--sqlplus-path
globalArgs: {sqlplus-path: "val"}
liquibase.sqlplus.path
LIQUIBASE_SQLPLUS_PATH

Path to sqlplus executable. For example:

• Linux: /opt/oracle/product/19.0.0/client/bin/sqlplus or /u01/app/oracle/product/19.0.0/dbhome_1/bin/sqlplus
• Windows: C:\oracle\product\19.0.0\dbhome_1\bin\sqlplus.exe

--sqlplus-sqlerror
globalArgs: {sqlplus-sqlerror: "val"}
liquibase.sqlplus.sqlerror
LIQUIBASE_SQLPLUS_SQLERROR

Control the outcome when Liquibase returns a SQL error. The error clause is passed directly to Oracle. Default: WHENEVER SQLERROR EXIT FAILURE. Accepted values include:

• WHENEVER SQLERROR EXIT FAILURE
• WHENEVER SQLERROR EXIT ROLLBACK
• WHENEVER SQLERROR EXIT ERROR
• WHENEVER SQLERROR EXIT WARNING
• WHENEVER SQLERROR EXIT SUCCESS

--sqlplus-timeout
globalArgs: {sqlplus-timeout: "val"}
liquibase.sqlplus.timeout
LIQUIBASE_SQLPLUS_TIMEOUT

Indicates seconds to wait for the sqlplus timeout. -1 disables the timeout. 0 returns an error. Default: 1800 (30 minutes).

--sqlplus-username
globalArgs: {sqlplus-username: "val"}
liquibase.sqlplus.username
LIQUIBASE_SQLPLUS_USERNAME

Liquibase 4.29.2+. Username to use with the native executor, such as account.username as sysdba to access Liquibase with an account that has SYSDBA privileges. Liquibase will attempt to use the name exactly as entered.

--reports-enabled
globalArgs: {reports-enabled: "val"}
liquibase.reports.enabled
LIQUIBASE_REPORTS_ENABLED

Enables or disables all reports at the global level. Overridden by --report-enabled at the command level. Default: true.

--reports-name
globalArgs: {reports-name: "val"}
liquibase.reports.name
LIQUIBASE_REPORTS_NAME

Specifies the name of the report file at the global level. Overridden by --report-name at the command level. By default, Liquibase generates a new report file labeled with a timestamp (user's local time). If you set a custom name, Liquibase overwrites the existing file every time you generate a new report. Default: report-<DD-Mon-YYYY-HHmmss>.html.

--reports-open
globalArgs: {reports-open: "val"}
liquibase.reports.open
LIQUIBASE_REPORTS_OPEN

Specifies whether to automatically open the report in your default browser at the global level. Overridden by --report-open at the command level. Default: true.

--reports-path
globalArgs: {reports-path: "val"}
liquibase.reports.path
LIQUIBASE_REPORTS_PATH

Specifies the file path to the report file at the global level. Overridden by --report-path at the command level. Default: ./

--reports-suppress-exception
globalArgs: {reports-suppress-exception: "val"}
liquibase.reports.suppressException
LIQUIBASE_REPORTS_SUPPRESS_EXCEPTION

Liquibase 4.31.0+. Specifies whether to hide exceptions (which may contain SQL) from operation reports at the global level. Overridden by --report-suppress-exception at the command level. Default: false. However:

• If --reports-suppress-exception is not set and --reports-suppress-sql=true, Liquibase suppresses all SQL, including exception SQL.
• If --reports-suppress-exception=false and --reports-suppress-sql=true, Liquibase suppresses most SQL but shows exception SQL.

--reports-suppress-sql
globalArgs: {reports-suppress-sql: "val"}
liquibase.reports.suppressSql
LIQUIBASE_REPORTS_SUPPRESS_SQL

Liquibase 4.31.0+. Specifies whether to hide changeset SQL in operation reports at the global level. Overridden by --report-suppress-sql at the command level. Default: false.

--custom-log-data-file
cmdArgs: {custom-log-data-file: "val"}
liquibase.customLogDataFile
LIQUIBASE_CUSTOM_LOG_DATA_FILE

--custom-log-data-frequency
cmdArgs: {custom-log-data-frequency: "val"}
liquibase.customLogDataFrequency
LIQUIBASE_CUSTOM_LOG_DATA_FREQUENCY

--script-python-executable-path
cmdArgs: {script-python-executable-path: "val"}
liquibase.script.python.executablePath
LIQUIBASE_SCRIPT_PYTHON_EXECUTABLE_PATH

Read more: --script-python-executable-path

--dynamodb-tracking-tables-billing-mode
globalArgs: {dynamodb-tracking-tables-billing-mode: "val"}
liquibase.dynamodb.trackingTables.billingMode
LIQUIBASE_DYNAMODB_TRACKING_TABLES_BILLING_MODE

Read more: --dynamodb-tracking-tables-billing-mode

Initial billing mode for Liquibase tracking tables (DBCL and DBCLL). This controls how you pay for database read/write operations and capacity. Valid values: PROVISIONED and PAY_PER_REQUEST. Default: PAY_PER_REQUEST. See also: BillingModeSummary.

Note: If you want to change the billing mode of the tracking tables after you create them, you must instead use the updateDynamoTable Change Type.

--dynamodb-tracking-tables-provisioned-throughput-read-capacity-units
globalArgs: {dynamodb-tracking-tables-provisioned-throughput-read-capacity-units: "val"}
liquibase.dynamodb.trackingTables.provisionedThroughput.readCapacityUnits
LIQUIBASE_DYNAMODB_TRACKING_TABLES_PROVISIONED_THROUGHPUT_READ_CAPACITY_UNITS

Read more: --dynamodb-tracking-tables-provisioned-throughput-read-capacity-units

Specifies how many readCapacityUnits to initially use for the PROVISIONED billing mode for Liquibase tracking tables (DBCL and DBCLL). Ignored for the PAY_PER_REQUEST billing mode. Default: 10. See also: Read/write capacity mode.

Note: If you want to change the provisioned throughput values of the tracking tables after you create them, you must instead use the updateDynamoTable or updateTableProvisionedThroughput Change Type.

--dynamodb-tracking-tables-provisioned-throughput-write-capacity-units
globalArgs: {dynamodb-tracking-tables-provisioned-throughput-write-capacity-units: "val"}
liquibase.dynamodb.trackingTables.provisionedThroughput.writeCapacityUnits
LIQUIBASE_DYNAMODB_TRACKING_TABLES_PROVISIONED_THROUGHPUT_WRITE_CAPACITY_UNITS

Read more: --dynamodb-tracking-tables-provisioned-throughput-write-capacity-units

Specifies how many writeCapacityUnits to initially use for the PROVISIONED billing mode for Liquibase tracking tables (DBCL and DBCLL). Ignored for the PAY_PER_REQUEST billing mode. Default: 10. See also: Read/write capacity mode.

Note: If you want to change the provisioned throughput values of the tracking tables after you create them, you must instead use the updateDynamoTable or updateTableProvisionedThroughput Change Type.

--dynamodb-waiters-enabled
globalArgs: {dynamodb-waiters-enabled: "val"}
liquibase.dynamodb.waiters.enabled
LIQUIBASE_DYNAMODB_WAITERS_ENABLED

Read more: --dynamodb-waiters-enabled

Specifies whether to enable or disable the DynamoDbWaiter for all Liquibase DynamoDB operations. When true, Liquibase waits for DynamoDB operations in a changeset to be fully complete before moving onto the next changeset. When false, Liquibase moves onto the next changeset while the first one may still be in a pending state, potentially saving time. When false, Liquibase also suppresses all other --dynamodb-waiter-* parameters. Default: true. See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

Warning: If you set this parameter to false, you risk unexpected behavior. You must ensure that any changesets you deploy do not try to access objects that are in a pending state.

--dynamodb-waiters-fail-on-timeout
globalArgs: {dynamodb-waiters-fail-on-timeout: "val"}
liquibase.dynamodb.waiters.failOnTimeout
LIQUIBASE_DYNAMODB_WAITERS_FAIL_ON_TIMEOUT

Read more: --dynamodb-waiters-fail-on-timeout

Specifies whether Liquibase fails if the DynamoDbWaiter times out while attempting to verify whether a resource like a table in your DynamoDB database is in a valid state. If true, Liquibase returns 1 when the waiter times out. If false, Liquibase returns 0 when the waiter times out. Default: true. See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

--dynamodb-waiters-log-notification-enabled
globalArgs: {dynamodb-waiters-log-notification-enabled: "val"}
liquibase.dynamodb.waiters.log.notification.enabled
LIQUIBASE_DYNAMODB_WAITERS_LOG_NOTIFICATION_ENABLED

Read more: --dynamodb-waiters-log-notification-enabled

Specifies whether Liquibase sends you periodic status notifications while the DynamoDbWaiter polls resources in your database. Default: true.

--dynamodb-waiters-log-notification-interval
globalArgs: {dynamodb-waiters-log-notification-interval: "val"}
liquibase.dynamodb.waiters.log.notification.interval
LIQUIBASE_DYNAMODB_WAITERS_LOG_NOTIFICATION_INTERVAL

Read more: --dynamodb-waiters-log-notification-interval

Specifies the interval in milliseconds for Liquibase to wait between sending status notifications while the DynamoDbWaiter polls resources in your database. Default: 4000.

--dynamodb-waiter-create-fixed-delay-backoff-strategy-duration
globalArgs: {dynamodb-waiter-create-fixed-delay-backoff-strategy-duration: "val"}
liquibase.dynamodb.waiter.create.fixedDelayBackoffStrategy.duration
LIQUIBASE_DYNAMODB_WAITER_CREATE_FIXED_DELAY_BACKOFF_STRATEGY_DURATION

Read more: --dynamodb-waiter-create-fixed-delay-backoff-strategy-duration

Number of seconds for the DynamoDbWaiter to wait before trying to poll your table again (between attempts). This interval is used between calls to verify that the table is created and operable. Default: 20. See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

--dynamodb-waiter-create-max-attempts
globalArgs: {dynamodb-waiter-create-max-attempts: "val"}
liquibase.dynamodb.waiter.create.maxAttempts
LIQUIBASE_DYNAMODB_WAITER_CREATE_MAX_ATTEMPTS

Read more: --dynamodb-waiter-create-max-attempts

Maximum number of attempts for the DynamoDbWaiter. The waiter repeatedly polls your table to see if it is created and operable. When the waiter exceeds this number of attempts, it enters a failure state. Default: 25. See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

--dynamodb-waiter-create-total-timeout
globalArgs: {dynamodb-waiter-create-total-timeout: "val"}
liquibase.dynamodb.waiter.create.totalTimeout
LIQUIBASE_DYNAMODB_WAITER_CREATE_TOTAL_TIMEOUT

Read more: --dynamodb-waiter-create-total-timeout

Total number of seconds for the DynamoDbWaiter to wait for the table to be created and operable. If the waiter sees that the table is in the correct state, the operation finishes and Liquibase moves onto the next changeset, no matter how much time has passed. If the waiter reaches the maximum timeout, Liquibase throws an error. Default: null (disabled). See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

--dynamodb-waiter-delete-fixed-delay-backoff-strategy-duration
globalArgs: {dynamodb-waiter-delete-fixed-delay-backoff-strategy-duration: "val"}
liquibase.dynamodb.waiter.delete.fixedDelayBackoffStrategy.duration
LIQUIBASE_DYNAMODB_WAITER_DELETE_FIXED_DELAY_BACKOFF_STRATEGY_DURATION

Read more: --dynamodb-waiter-delete-fixed-delay-backoff-strategy-duration

Number of seconds for the DynamoDbWaiter to wait before trying to poll your table again (between attempts). This interval is used between calls to verify that the table is deleted. Default: 20. See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

--dynamodb-waiter-delete-max-attempts
globalArgs: {dynamodb-waiter-delete-max-attempts: "val"}
liquibase.dynamodb.waiter.delete.maxAttempts
LIQUIBASE_DYNAMODB_WAITER_DELETE_MAX_ATTEMPTS

Read more: --dynamodb-waiter-delete-max-attempts

Maximum number of attempts for the DynamoDbWaiter. The waiter repeatedly polls your table to see if it is deleted. When the waiter exceeds this number of attempts, it enters a failure state. Default: 25. See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

--dynamodb-waiter-delete-total-timeout
globalArgs: {dynamodb-waiter-delete-total-timeout: "val"}
liquibase.dynamodb.waiter.delete.totalTimeout
LIQUIBASE_DYNAMODB_WAITER_DELETE_TOTAL_TIMEOUT

Read more: --dynamodb-waiter-delete-total-timeout

Total number of seconds for the DynamoDbWaiter to wait for the table to be deleted. If the waiter sees that the table is in the correct state, the operation finishes and Liquibase moves onto the next changeset, no matter how much time has passed. If the waiter reaches the maximum timeout, Liquibase throws an error. Default: null (disabled). See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

--dynamodb-waiter-update-fixed-delay-backoff-strategy-duration
globalArgs: {dynamodb-waiter-update-fixed-delay-backoff-strategy-duration: "val"}
liquibase.dynamodb.waiter.update.fixedDelayBackoffStrategyDuration
LIQUIBASE_DYNAMODB_WAITER_UPDATE_FIXED_DELAY_BACKOFF_STRATEGY_DURATION

Read more: --dynamodb-waiter-update-fixed-delay-backoff-strategy-duration

Number of seconds for the DynamoDbWaiter to wait before trying to poll your table again (between attempts). This interval is used between calls to verify that the table is updated and operable. Default: 20. See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

--dynamodb-waiter-update-max-attempts
globalArgs: {dynamodb-waiter-update-max-attempts: "val"}
liquibase.dynamodb.waiter.update.maxAttempts
LIQUIBASE_DYNAMODB_WAITER_UPDATE_MAX_ATTEMPTS

Read more: --dynamodb-waiter-update-max-attempts

Maximum number of attempts for the DynamoDbWaiter. The waiter repeatedly polls your table to see if it is updated and operable. When the waiter exceeds this number of attempts, it enters a failure state. Default: 25. See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

--dynamodb-waiter-update-total-timeout
globalArgs: {dynamodb-waiter-update-total-timeout: "val"}
liquibase.dynamodb.waiter.update.totalTimeout
LIQUIBASE_DYNAMODB_WAITER_UPDATE_TOTAL_TIMEOUT

Read more: --dynamodb-waiter-update-total-timeout

Total number of seconds for the DynamoDbWaiter to wait for the table to be updated and operable. If the waiter sees that the table is in the correct state, the operation finishes and Liquibase moves onto the next changeset, no matter how much time has passed. If the waiter reaches the maximum timeout, Liquibase throws an error. Default: null (disabled). See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

--databricks-auth-mechanism
globalArgs: {databricks-auth-mechanism: "val"}
liquibase.databricks.authMechanism
LIQUIBASE_DATABRICKS_AUTH_MECHANISM

Read more: --databricks-auth-mechanism

Liquibase Pro Databricks extension 1.0.0+. Specifies the authentication mechanism for Liquibase to use with Databricks. Valid values are: OAUTH. If no value is specified, Liquibase tries to connect using a username and password.

--databricks-catalog
globalArgs: {databricks-catalog: "val"}
liquibase.databricks.catalog
LIQUIBASE_DATABRICKS_CATALOG

Read more: --databricks-catalog

Liquibase Pro Databricks extension 1.0.0+. Specifies the catalog for Liquibase to use with Databricks.

--databricks-http-path
globalArgs: {databricks-http-path: "val"}
liquibase.databricks.httpPath
LIQUIBASE_DATABRICKS_HTTP_PATH

Read more: --databricks-http-path

Liquibase Pro Databricks extension 1.0.0+. Specifies the HTTP path of the compute resource (a Databricks cluster or a Databricks SQL warehouse) for Liquibase to use.

--databricks-oauth-auth-flow
globalArgs: {databricks-oauth-auth-flow: "val"}
liquibase.databricks.oauth.authFlow
LIQUIBASE_DATABRICKS_OAUTH_AUTH_FLOW

Read more: --databricks-oauth-auth-flow

Liquibase Pro Databricks extension 1.0.0+. Specifies the OAuth2 authentication flow for the Databricks driver connection. Valid values are: 1. Default: 1.

--databricks-oauth-client-id
globalArgs: {databricks-oauth-client-id: "val"}
liquibase.databricks.oauth.clientId
LIQUIBASE_DATABRICKS_OAUTH_CLIENT_ID

Read more: --databricks-oauth-client-id

Liquibase Pro Databricks extension 1.0.0+. Specifies the Client ID for OAuth authentication on Databricks. The Client ID is the service principal's UUID or Application ID value.

--databricks-oauth-client-secret
globalArgs: {databricks-oauth-client-secret: "val"}
liquibase.databricks.oauth.clientSecret
LIQUIBASE_DATABRICKS_OAUTH_CLIENT_SECRET

Read more: --databricks-oauth-client-secret

Liquibase Pro Databricks extension 1.0.0+. Specifies the Client Secret for OAuth authentication on Databricks. The Client Secret is the service principal's OAuth Secret value.

--databricks-schema
globalArgs: {databricks-schema: "val"}
liquibase.databricks.schema
LIQUIBASE_DATABRICKS_SCHEMA

Read more: --databricks-schema

Liquibase Pro Databricks extension 1.0.0+. Specifies the schema for Liquibase to use with Databricks.

--mongodb-adjust-tracking-tables-on-startup
globalArgs: {adjust-tracking-tables-on-startup: "val"}
liquibase.mongodb.adjustTrackingTablesOnStartup
LIQUIBASE_MONGODB_ADJUST_TRACKING_TABLES_ON_STARTUP

Read more: --mongodb-adjust-tracking-tables-on-startup

Validates the Liquibase DATABASECHANGELOG and DATABASECHANGELOGLOCK collections on startup. If they are not up to date with the current release, Liquibase adjusts them. It is a best practice to keep this parameter enabled whenever you upgrade to a new Liquibase version. Default: true.

--mongodb-oidc-authentication-mechanism
globalArgs: {mongodb-oidc-authentication-mechanism: "val"}
liquibase.mongodb.oidc.authenticationMechanism
LIQUIBASE_MONGODB_OIDC_AUTHENTICATION_MECHANISM

Read more: --mongodb-oidc-authentication-mechanism

Authentication mechanism for MongoDB. Valid values are: MONGODB-OIDC. If no value is specified, Liquibase tries to connect using a username and password. For more information, see MongoDB: Enterprise Authentication Mechanisms.

--mongodb-oidc-environment
globalArgs: {mongodb-oidc-environment: "val"}
liquibase.mongodb.oidc.environment
LIQUIBASE_MONGODB_OIDC_ENVIRONMENT

Read more: --mongodb-oidc-environment

Cloud provider environment for OIDC authentication. Valid values are: azure. Required if --mongodb-oidc-authentication-mechanism is specified.

--mongodb-oidc-oidc-application-id-uri
globalArgs: {mongodb-oidc-oidc-application-id-uri: "val"}
liquibase.mongodb.oidc.oidcApplicationIDURI
LIQUIBASE_MONGODB_OIDC_OIDC_APPLICATION_ID_URI

Read more: --mongodb-oidc-oidc-application-id-uri

Application ID URI used for OIDC authentication in cloud providers. For example, with Azure: api://8d719796-c744-4352-aab9-47a52c363907. Required if --mongodb-oidc-authentication-mechanism is specified.

--mongodb-oidc-oidc-client-id
globalArgs: {mongodb-oidc-oidc-client-id: "val"}
liquibase.mongodb.oidc.oidcClientID
LIQUIBASE_MONGODB_OIDC_OIDC_CLIENT_ID

Read more: --mongodb-oidc-oidc-client-id

Client ID of the User-Assigned Identity for OIDC authentication.

--mongodb-retry-writes
globalArgs: {retry-writes: "val"}
liquibase.mongodb.retryWrites
LIQUIBASE_MONGODB_RETRY_WRITES

Read more: --mongodb-retry-writes

Specifies whether to retry write operations a single time after a failed write. If true, Liquibase appends retryWrites=true to the connection URL. If false, Liquibase appends retryWrites=false. Setting this parameter to false permits Liquibase usage on MongoDB versions not supporting retryWrites, like Amazon DocumentDB. Default: true.

--mongodb-supports-validator
globalArgs: {supports-validator: "val"}
liquibase.mongodb.supportsValidator
LIQUIBASE_MONGODB_SUPPORTS_VALIDATOR

Read more: --mongodb-supports-validator

Specifies whether to create the Liquibase tracking collections with validators. Setting this parameter to false permits usage on MongoDB versions not supporting validators. Default: true.

liquibase.home
LIQUIBASE_HOME

The directory that points to the Liquibase installation location.

liquibase.launcher.debug
LIQUIBASE_LAUNCHER_DEBUG

Enables the Liquibase debug mode, which produces more log output and allows the user to debug their database.

liquibase.launcher.parent.classloader
LIQUIBASE_LAUNCHER_PARENT_CLASSLOADER

The classloader that runs Liquibase via either system or thread. This variable defaults to system.

--default-logger-level
globalArgs: {default-logger-level: "val"}
liquibase.defaultLoggerLevel
LIQUIBASE_DEFAULT_LOGGER_LEVEL

--filter-log-messages
globalArgs: {filter-log-messages: "val"}
liquibase.filterLogMessages
LIQUIBASE_FILTER_LOG_MESSAGES

--native-executor
globalArgs: {native-executors: "val"}
liquibase.nativeExecutor
LIQUIBASE_NATIVE_EXECUTOR

-D

--changelog-file
cmdArgs: {changelog-file: "val"}
liquibase.command.changelogFile
LIQUIBASE_COMMAND_CHANGELOG_FILE

--driver
cmdArgs: {driver: "val"}
liquibase.command.driver
LIQUIBASE_COMMAND_DRIVER

The JDBC driver class

--driver-properties-file
cmdArgs: {driver-properties-file: "val"}
liquibase.command.driverPropertiesFile
LIQUIBASE_COMMAND_DRIVER_PROPERTIES_FILE

The JDBC driver properties file

--password
cmdArgs: {password: "val"}
liquibase.command.password
LIQUIBASE_COMMAND_PASSWORD

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.

--reference-default-catalog-name
cmdArgs: {reference-default-catalog-name: "val"}
liquibase.command.referenceDefaultCatalogName
LIQUIBASE_COMMAND_REFERENCE_DEFAULT_CATALOG_NAME

The reference default catalog name to use for the database connection

--reference-default-schema-name
cmdArgs: {reference-default-schema-name: "val"}
liquibase.command.referenceDefaultSchemaName
LIQUIBASE_COMMAND_REFERENCE_DEFAULT_SCHEMA_NAME

The reference default schema name to use for the database connection

--reference-driver
cmdArgs: {reference-driver: "val"}
liquibase.command.referenceDriver
LIQUIBASE_COMMAND_REFERENCE_DRIVER

The JDBC driver class for the reference database

--reference-driver-properties-file
cmdArgs: {reference-driver-properties-file: "val"}
liquibase.command.referenceDriverPropertiesFile
LIQUIBASE_COMMAND_REFERENCE_DRIVER_PROPERTIES_FILE

The JDBC driver properties file for the reference database

--reference-password
cmdArgs: {reference-password: "val"}
liquibase.command.referencePassword
LIQUIBASE_COMMAND_REFERENCE_PASSWORD

The reference database password.

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

--reference-schemas
cmdArgs: {reference-schemas: "val"}
liquibase.command.referenceSchemas
LIQUIBASE_COMMAND_REFERENCE_SCHEMAS

Schemas names on reference database to use in diff. This is a CSV list.

--reference-url
cmdArgs: {reference-url: "val"}
liquibase.command.referenceUrl
LIQUIBASE_COMMAND_REFERENCE_URL

The JDBC reference database connection URL

--reference-username
cmdArgs: {reference-username: "val"}
liquibase.command.referenceUsername
LIQUIBASE_COMMAND_REFERENCE_USERNAME

The reference database username.

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

--url
cmdArgs: {url: "val"}
liquibase.command.url
LIQUIBASE_COMMAND_URL

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

--username
cmdArgs: {username: "val"}
liquibase.command.username
LIQUIBASE_COMMAND_USERNAME

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.

--recursive
cmdArgs: {recursive: "val"}
liquibase.command.init.copy.recursive
LIQUIBASE_COMMAND_INIT_COPY_RECURSIVE

Recursively copy files from the source directory. Default: false

--source
cmdArgs: {source: "val"}
liquibase.command.init.copy.source
LIQUIBASE_COMMAND_INIT_COPY_SOURCE

Source directory where the project files will be copied from. Default: .

--target
cmdArgs: {target: "val"}
liquibase.command.init.copy.target
LIQUIBASE_COMMAND_INIT_COPY_TARGET

Path to the directory where the project files will be created

--changelog-file
cmdArgs: {changelog-file: "val"}
liquibase.command.init.project.changelog-file
LIQUIBASE_COMMAND_INIT_PROJECT_CHANGELOG_FILE

Relative or fully qualified path to the changelog file. Default: example-changelog

--format
cmdArgs: {format: "val"}
liquibase.command.init.project.format
LIQUIBASE_COMMAND_INIT_PROJECT_FORMAT

Format of the project changelog file: sql|xml|json|yaml|yml. Default: sql

--keep-temp-files
cmdArgs: {keep-temp-files: "val"}
liquibase.command.init.project.keepTempFiles
LIQUIBASE_COMMAND_INIT_PROJECT_KEEP_TEMP_FILES

For remote project locations, do not delete temporary project files. Default: false

--password
cmdArgs: {password: "val"}
liquibase.command.init.project.password
LIQUIBASE_COMMAND_INIT_PROJECT_PASSWORD

Password to use to connect to the database. Default: letmein

--project-defaults-file
cmdArgs: {project-defaults-file: "val"}
liquibase.command.init.project.projectDefaultsFile
LIQUIBASE_COMMAND_INIT_PROJECT_PROJECT_DEFAULTS_FILE

File with default Liquibase properties. Default: liquibase.properties

--project-dir
cmdArgs: {project-dir: "val"}
liquibase.command.init.project.projectDir
LIQUIBASE_COMMAND_INIT_PROJECT_PROJECT_DIR

An optional parameter used to specify the directory containing files (existing or to be auto-created) to be used with Liquibase. Default: ./

--project-guide
cmdArgs: {project-guide: "val"}
liquibase.command.init.project.projectGuide
LIQUIBASE_COMMAND_INIT_PROJECT_PROJECT_GUIDE

Parameter that turns on or turns off the CLI interactive mode. For example, if you want to set one parameter and have the rest as default ones, run the parameter and set --project-guide=off to not be asked about the rest of the settings: liquibase init project --changelog=mychangelog.sql --project-guide=off. Default: on

--url
cmdArgs: {url: "val"}
liquibase.command.init.project.url
LIQUIBASE_COMMAND_INIT_PROJECT_URL

The JDBC database connection URL. See Using JDBC URL in Liquibase. Default: jdbc:h2:tcp://localhost:9090/mem:dev

--username
cmdArgs: {username: "val"}
liquibase.command.init.project.username
LIQUIBASE_COMMAND_INIT_PROJECT_USERNAME

Username to connect to the database. Default: dbuser

--bind-address
cmdArgs: {bind-address: "val"}
liquibase.command.init.startH2.bindAddress
LIQUIBASE_COMMAND_INIT_START_H2_BIND_ADDRESS

Network address to bind to. Default: 127.0.0.1

--db-port
cmdArgs: {db-port: "val"}
liquibase.command.init.startH2.dbPort
LIQUIBASE_COMMAND_INIT_START_H2_DB_PORT

Port to run h2 database on. Default: 9090

--launch-browser
cmdArgs: {launch-browser: "val"}
liquibase.command.init.startH2.launchBrowser
LIQUIBASE_COMMAND_INIT_START_H2_LAUNCH_BROWSER

Whether to open a browser to the database's web interface. Default: true

--password
cmdArgs: {password: "val"}
liquibase.command.init.startH2.password
LIQUIBASE_COMMAND_INIT_START_H2_PASSWORD

Password to use for created h2 user. Default: letmein

--username
cmdArgs: {username: "val"}
liquibase.command.init.startH2.username
LIQUIBASE_COMMAND_INIT_START_H2_USERNAME

Username to create in h2. Default: dbuser

--web-port
cmdArgs: {web-port: "val"}
liquibase.command.init.startH2.webPort
LIQUIBASE_COMMAND_INIT_START_H2_WEB_PORT

Port to run h2's web interface on. Default: 8080

--flow-file
cmdArgs: {flow-file: "val"}
liquibase.command.flowFile
LIQUIBASE_COMMAND_FLOW_FILE

The path to the configuration YAML file which contains one or more "stages" of commands to be executed in a liquibase flow operation. Default: liquibase.flowfile.yaml.

--flow-file-strict-parsing
cmdArgs: {flow-file-strict-parsing: "val"}
liquibase.command.flowFileStrictParsing
LIQUIBASE_COMMAND_FLOW_FILE_STRICT_PARSING

If true, parse flow file YAML to allow only Liquibase flow file-specific properties, indentations, and structures. Default: true.

--flow-shell-interpreter
cmdArgs: {flow-shell-interpreter: "val"}
liquibase.command.flowShellInterpreter
LIQUIBASE_COMMAND_FLOW_SHELL_INTERPRETER

The default interpreter used to execute shell commands. Examples include bash, sh, and cmd.

--flow-shell-keep-temp-files
cmdArgs: {flow-shell-keep-temp-files: "val"}
liquibase.command.flowShellKeepTempFiles
LIQUIBASE_COMMAND_FLOW_SHELL_KEEP_TEMP_FILES

If true, do not delete temporary files created by the shell command execution. Default: false.

--auto-enable-new-checks
cmdArgs: {auto-enable-new-checks: "val"}
liquibase.command.checks.<subcommand>.autoEnableNewChecks
LIQUIBASE_COMMAND_CHECKS_<subcommand>_AUTO_ENABLE_NEW_CHECKS

Automatically enable new policy checks in liquibase.checks.conf file when they are available. Default: false.

--auto-update
cmdArgs: {auto-update: "val"}
liquibase.command.checks.<subcommand>.autoUpdate
LIQUIBASE_COMMAND_CHECKS_<subcommand>_AUTO_UPDATE

Allows automatic backup and updating of the liquibase.checks-settings.conf file when new policy checks are available. Valid values are ON and OFF. Default: OFF.

--cache-changelog-file-contents
cmdArgs: {cache-changelog-file-contents: "val"}
liquibase.command.checks.<subcommand>.cacheChangelogFileContents
LIQUIBASE_COMMAND_CHECKS_<subcommand>_CACHE_CHANGELOG_FILE_CONTENTS

If true, sqlFile Change Type contents are cached in memory to improve performance, at the cost of higher memory usage. To reduce memory usage, set this to false. Default: true

--changelog-file
cmdArgs: {changelog-file: "val"}
liquibase.command.checks.<subcommand>.changelogFile
LIQUIBASE_COMMAND_CHECKS_<subcommand>_CHANGELOG_FILE

The changelog file against which you execute checks when running liquibase checks run.

--changeset-filter
cmdArgs: {changeset-filter: "val"}
liquibase.command.checks.<subcommand>.changesetFilter
LIQUIBASE_COMMAND_CHECKS_<subcommand>_CHANGESET_FILTER

Specifies whether policy checks run on ALL changesets or only PENDING (undeployed) changesets. Only applies to checks with the "changelog" scope. Liquibase 4.26.0+. Default: ALL.

--check-name
cmdArgs: {check-name: "val"}
liquibase.command.checks.<subcommand>.checkName
LIQUIBASE_COMMAND_CHECKS_<subcommand>_CHECK_NAME

The name of the check(s) you want to target. Comma-separated list of one or more enabled checks. Checks to exclude can be prefixed with the ! character. If no checks are specified, all enabled checks are targeted. For example: --check-name=shortname1,shortname2,!shortname3

--check-rollbacks
cmdArgs: {check-rollbacks: "val"}
liquibase.command.checks.<subcommand>.checkRollbacks
LIQUIBASE_COMMAND_CHECKS_<subcommand>_CHECK_ROLLBACKS

Allow changeset's rollback code to be analyzed for compliance with currently enabled policy checks. Default: false

--check-status
cmdArgs: {check-status: "val"}
liquibase.command.checks.<subcommand>.checkStatus
LIQUIBASE_COMMAND_CHECKS_<subcommand>_CHECK_STATUS

Only show the checks that are in the specified status. Valid values are ENABLED, DISABLED, and ALL. Default: ALL

--checks-output
cmdArgs: {checks-output: "val"}
liquibase.command.checks.<subcommand>.checksOutput
LIQUIBASE_COMMAND_CHECKS_<subcommand>_CHECKS_OUTPUT

Specify which parts of the checks run output should be shown. Options:

• all: show all sections
• issues: show the triggered checks
• issues0: show the issues with severity 0
• issues1: show the issues with severity 1
• issues2: show the issues with severity 2
• issues3: show the issues with severity 3
• issues4: show the issues with severity 4
• validated: show the section that starts with "Changesets Validated"
• checksrun: show the section that starts with "Checks run against each changeset"
• sqlparserfails: show the section that starts with "Changeset SQL not parsed in..."
• skippedchecks: show the section that starts with "Changelogs Checks Skipped Due to unsupported changeset..." (such as checks skipped due to version incompatibility)
• nonapplicablechecks: show chained checks which cannot be evaluated due to their configurations conflicting (such as a chained check that evaluates TableColumnLimit && ObjectNameMustMatch, where TableColumnLimit only evaluates tables and ObjectNameMustMatch is configured to only evaluate indexes).

Default: all

--checks-packages
cmdArgs: {checks-packages: "val"}
liquibase.command.checks.<subcommand>.checksPackages
LIQUIBASE_COMMAND_CHECKS_<subcommand>_CHECKS_PACKAGES

If using a checks packages file, optionally specify which packages should be run from the file as a comma-separated list.

--checks-scope
cmdArgs: {checks-scope: "val"}
liquibase.command.checks.<subcommand>.checksScope
LIQUIBASE_COMMAND_CHECKS_<subcommand>_CHECKS_SCOPE

The Liquibase component to run checks against, which can be a comma-separated list. Valid values are changelog and database. Default: changelog. See checks-scope.

--checks-scripts-enabled
cmdArgs: {checks-scripts-enabled: "val"}
liquibase.command.checks.<subcommand>.checksScriptsEnabled
LIQUIBASE_COMMAND_CHECKS_<subcommand>_CHECKS_SCRIPTS_ENABLED

Allow execution of custom script checks. For more information, see Liquibase Pro Custom Policy Checks. Default: false

--checks-scripts-path
cmdArgs: {checks-scripts-path: "val"}
liquibase.command.checks.<subcommand>.checksScriptsPath
LIQUIBASE_COMMAND_CHECKS_<subcommand>_CHECKS_SCRIPTS_PATH

Only allow custom scripts found in the specified directories to execute. If not set, Liquibase allows custom scripts from any location to execute. For more information, see Liquibase Pro Custom Policy Checks.

--checks-settings-file
cmdArgs: {checks-settings-file: "val"}
liquibase.command.checks.<subcommand>.checksSettingsFile
LIQUIBASE_COMMAND_CHECKS_<subcommand>_CHECKS_SETTINGS_FILE

Specifies the checks settings file to use with policy checks commands. Write the relative path of the settings file that you want to read from or modify. For more information, see Use the Checks Settings Configuration File.

--disable
cmdArgs: {disable: "val"}
liquibase.command.checks.<subcommand>.disable
LIQUIBASE_COMMAND_CHECKS_<subcommand>_DISABLE

Disable all qualifying checks in the checks settings file. Default: true.

--enable
cmdArgs: {enable: "val"}
liquibase.command.checks.<subcommand>.enable
LIQUIBASE_COMMAND_CHECKS_<subcommand>_ENABLE

Enable all qualifying checks in the checks settings file. Default: false.

--force
cmdArgs: {force: "val"}
liquibase.command.checks.<subcommand>.force
LIQUIBASE_COMMAND_CHECKS_<subcommand>_FORCE

If true, Liquibase does not ask for confirmation when you run this command. Default: false.

--format
cmdArgs: {format: "val"}
liquibase.command.checks.<subcommand>.format
LIQUIBASE_COMMAND_CHECKS_<subcommand>_FORMAT

Sets the format of the check output to text or JSON. Valid values are TXT, JSON. Default: TXT. For more information, see Policy Checks JSON Object.

--package-contents
cmdArgs: {package-contents: "val"}
liquibase.command.checks.<subcommand>.packageContents
LIQUIBASE_COMMAND_CHECKS_<subcommand>_PACKAGE_CONTENTS

One or more comma-separated relative path(s) to the checks settings files (or to a directory of files) to be bundled into the checks package. If the value is a directory, all files will be added to the --package-name object, but not recursively.

--package-file
cmdArgs: {package-file: "val"}
liquibase.command.checks.<subcommand>.packageFile
LIQUIBASE_COMMAND_CHECKS_<subcommand>_PACKAGE_FILE

The relative or fully qualified path and filename of the YAML file to create. Default: liquibase.checks-package.yaml.

--package-name
cmdArgs: {package-name: "val"}
liquibase.command.checks.<subcommand>.packageName
LIQUIBASE_COMMAND_CHECKS_<subcommand>_PACKAGE_NAME

The name of the checks package object to be created inside the checks package YAML file.

--property-substitution-enabled
cmdArgs: {property-substitution-enabled: "val"}
liquibase.command.checks.<subcommand>.propertySubstitutionEnabled
LIQUIBASE_COMMAND_CHECKS_<subcommand>_PROPERTY_SUBSTITUTION_ENABLED

If set to true, changesets are evaluated by checks run after property substitution. If set to false, changesets are evaluated by checks run before property substitution, meaning the names of the "property substitution tokens" are evaluated. Default: true. For more information, see property-substitution-enabled.

--schemas
cmdArgs: {schemas: "val"}
liquibase.command.checks.<subcommand>.schemas
LIQUIBASE_COMMAND_CHECKS_<subcommand>_SCHEMAS

The schemas to check when --checks-scope contains database.

--severity
cmdArgs: {severity: "val"}
liquibase.command.checks.<subcommand>.severity
LIQUIBASE_COMMAND_CHECKS_<subcommand>_SEVERITY

Set the severity to return a code of 0–4 when the check is triggered. Default: 0.

--show-cols
cmdArgs: {show-cols: "val"}
liquibase.command.checks.<subcommand>.showCols
LIQUIBASE_COMMAND_CHECKS_<subcommand>_SHOW_COLS

Only show the specified columns. Column options: id, checkname, type, priority, shortname, scope, status, severity, customization, description, and all. Specify multiple columns in a comma-separated list. Specify all to select all the columns. Default: shortname,scope,severity,customization,description

--sql-parser-fail-severity
cmdArgs: {sql-parser-fail-severity: "val"}
liquibase.command.checks.<subcommand>.sqlParserFailSeverity
LIQUIBASE_COMMAND_CHECKS_<subcommand>_SQL_PARSER_FAIL_SEVERITY

Specifies the severity value returned when a check fails due to a SQL parse error. Valid values are the following return codes:

• 0 is INFO
• 1 is MINOR
• 2 is MAJOR
• 3 is CRITICAL
• 4 is BLOCKER

Default: severity of the executed check

--url
cmdArgs: {url: "val"}
liquibase.command.checks.<subcommand>.url
LIQUIBASE_COMMAND_CHECKS_<subcommand>_URL

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

--drift-severity
cmdArgs: {drift-severity: "val"}
liquibase.command.<cmdName>.driftSeverity
LIQUIBASE_COMMAND_<CMDNAME>_DRIFT_SEVERITY

Specifies the severity level of all error types in the drift report (changed, missing, or unexpected content). Valid values are INFO (0), MINOR (1), MAJOR (2), CRITICAL (3), and BLOCKER (4), from least severe to most severe. If both --drift-severity and one of the individual error type arguments are set, the individual error type arguments take priority. Default: INFO.

--drift-severity-changed
cmdArgs: {drift-severity-changed: "val"}
liquibase.command.<cmdName>.driftSeverityChanged
LIQUIBASE_COMMAND_<CMDNAME>_DRIFT_SEVERITY_CHANGED

Specifies the severity level of changed content in the drift report. Valid values are INFO (0), MINOR (1), MAJOR (2), CRITICAL (3), and BLOCKER (4), from least severe to most severe. Overrides the value of --drift-severity for changed content only. Default: INFO.

--drift-severity-missing
cmdArgs: {drift-severity-missing: "val"}
liquibase.command.<cmdName>.driftSeverityMissing
LIQUIBASE_COMMAND_<CMDNAME>_DRIFT_SEVERITY_MISSING

Specifies the severity level of missing content in the drift report. Valid values are INFO (0), MINOR (1), MAJOR (2), CRITICAL (3), and BLOCKER (4), from least severe to most severe. Overrides the value of --drift-severity for missing content only. Default: INFO.

--drift-severity-unexpected
cmdArgs: {drift-severity-unexpected: "val"}
liquibase.command.<cmdName>.driftSeverityUnexpected
LIQUIBASE_COMMAND_<CMDNAME>_DRIFT_SEVERITY_UNEXPECTED

Specifies the severity level of unexpected content in the drift report. Valid values are INFO (0), MINOR (1), MAJOR (2), CRITICAL (3), and BLOCKER (4), from least severe to most severe. Overrides the value of --drift-severity for unexpected content only. Default: INFO.

--open-report
cmdArgs: {open-report: "val"}
liquibase.command.<cmdName>.openReport
LIQUIBASE_COMMAND_<CMDNAME>_OPEN_REPORT

If true, automatically opens the report in your default browser. Default: false.

Note: Prior to Liquibase 4.29.0, this parameter was called --open-report instead of --report-open.

--report-enabled
cmdArgs: {report-enabled: "val"}
liquibase.command.<cmdName>.reportEnabled
LIQUIBASE_COMMAND_<CMDNAME>_REPORT_ENABLED

Enables a report at the command level. Overrides the global parameter --reports-enabled. Default: true.

--report-name
cmdArgs: {report-name: "val"}
liquibase.command.<cmdName>.reportName
LIQUIBASE_COMMAND_<CMDNAME>_REPORT_NAME

Specifies the name of the report file at the command level. Overrides the global parameter --reports-name. By default, Liquibase generates a new report file labeled with a timestamp (user's local time). If you set a custom name, Liquibase overwrites the existing file every time you generate a new report. Default: report-<DD-Mon-YYYY-HHmmss>.html.

--report-path
cmdArgs: {report-path: "val"}
liquibase.command.<cmdName>.reportPath
LIQUIBASE_COMMAND_<CMDNAME>_REPORT_PATH

Specifies the file path to the report file at the command level. Overrides the global parameter --reports-path. Default: ./.

--report-suppress-exception
cmdArgs: {report-suppress-exception: "val"}
liquibase.command.<cmdName>.reportSuppressException
LIQUIBASE_COMMAND_<CMDNAME>_REPORT_SUPPRESS_EXCEPTION

Liquibase 4.31.0+. Specifies whether to hide exceptions (which may contain SQL) from the operation report at the command level. Overrides the global parameter --reports-suppress-exception. Default: false. However:

• If --report-suppress-exception is not set and --report-suppress-sql=true, Liquibase suppresses all SQL, including exception SQL.
• If --report-suppress-exception=false and --report-suppress-sql=true, Liquibase suppresses most SQL but shows exception SQL.

--report-suppress-sql
cmdArgs: {report-suppress-sql: "val"}
liquibase.command.<cmdName>.reportSuppressSql
LIQUIBASE_COMMAND_<CMDNAME>_REPORT_SUPPRESS_SQL

Liquibase 4.31.0+. Specifies whether to hide changeset SQL in operation reports at the command level. Overridden by the global parameter --reports-suppress-sql. Default: false.

--add-row
cmdArgs: {add-row: "val"}
liquibase.command.addRow
LIQUIBASE_COMMAND_ADD_ROW

Liquibase Pro only. If true, creates a new DATABASECHANGELOG row for the tag you're adding. If false, adds the new tag to the last existing row. Liquibase 4.23.1+. Requires a Liquibase Pro license key. Default: false.

Note: If you create a new DATABASECHANGELOG row for your tag but later roll back that tag, Liquibase also rolls back the row you created.

--change-exec-listener-class
cmdArgs: {change-exec-listener-class: "val"}
liquibase.command.changeExecListenerClass
LIQUIBASE_COMMAND_CHANGE_EXEC_LISTENER_CLASS

--change-exec-listener-properties-file
cmdArgs: {change-exec-listener-properties-file: "val"}
liquibase.command.changeExecListenerPropertiesFile
LIQUIBASE_COMMAND_CHANGE_EXEC_LISTENER_PROPERTIES_FILE

--changeset-author
cmdArgs: {changeset-author: "val"}
liquibase.command.changesetAuthor
LIQUIBASE_COMMAND_CHANGESET_AUTHOR

The name of the author for the changeset. Supports * as a wildcard.

For calculate-checksum:

Liquibase 4.25.0+. Author of the changeset. Cannot be used with --changeset-identifier.

--changeset-id
cmdArgs: {changeset-id: "val"}
liquibase.command.changesetId
LIQUIBASE_COMMAND_CHANGESET_ID

The changeset ID from the changelog.

For calculate-checksum:

Liquibase 4.25.0+. ID of the changeset. Cannot be used with --changeset-identifier.

--changeset-identifier
cmdArgs: {changeset-identifier: "val"}
liquibase.command.changesetIdentifier
LIQUIBASE_COMMAND_CHANGESET_IDENTIFIER

Tag defined as a number or a descriptive name that is unique to each changeset. Requires the following format: filepath::id::author. Specify as --changeset-identifier=value. Positional format <command> <value> deprecated in 4.4+.

In 4.25.0+, you can either specify --changeset-identifier in the filepath::id::author format or specify --changeset-author, --changeset-id, and --changeset-path individually. However, you cannot specify a changeset in both ways.

Only valid for the calculate-checksum command. For the update-one-changeset and rollback-one-changeset commands, use --changeset-id instead.

--changeset-path
cmdArgs: {changeset-path: "val"}
liquibase.command.changesetPath
LIQUIBASE_COMMAND_CHANGESET_PATH

The path to the changelog containing the changeset you want to target. For example, you may have a root changelog (root.sql) and a child changelog (child.sql). To target a specific changeset in child.sql, specify --changeset-path=child.sql.

• If root.sql uses include, includeAll, or sqlFile to reference child.sql, you must also specify --changelog-file=root.sql (file and path are different).
• If root.sql does not reference child.sql, you must also specify --changelog-file=child.sql (file and path are the same).

If you only have one changelog, then --changelog-file and --changeset-path must also be the same.

For calculate-checksum:

Liquibase 4.25.0+. Path of the changelog that contains the changeset. Cannot be used with --changeset-identifier.

--context-filter
cmdArgs: {context-filter: "val"}
liquibase.command.contextFilter
LIQUIBASE_COMMAND_CONTEXT_FILTER

Specifies the changeset contexts to match. Contexts are tags you can add to changesets to control which changesets are executed in any particular migration run.

Note: If you use Liquibase 4.23.0 or earlier, use the syntax --contexts instead of --context-filter.

--count
cmdArgs: {count: "val"}
liquibase.command.count
LIQUIBASE_COMMAND_COUNT

--data-output-directory
cmdArgs: {data-output-directory: "val"}
liquibase.command.dataOutputDirectory
LIQUIBASE_COMMAND_DATA_OUTPUT_DIRECTORY

Specifies a directory to send the loadData output to a CSV file which is generated by running the diff-changelog or generate-changelog command.

--date
cmdArgs: {date: "val"}
liquibase.command.date
LIQUIBASE_COMMAND_DATE

The date and time your database rolls back to. The date format is YYYY-MM-DD HH:MM:SS or YYYY-MM-DD'T'HH:MM:SS. However, it is possible to indicate the date or time only. Specify as --date=myDate. Positional format <command> <date> deprecated in 4.4+.

--drop-dbclhistory
cmdArgs: {date: "val"}
liquibase.command.dropDbclhistory
LIQUIBASE_COMMAND_DROP_DBCLHISTORY

Liquibase 4.27.0+. If true, Liquibase drops the DATABASECHANGELOGHISTORY table along with other database objects owned by the user. Default: false.

--dbms
cmdArgs: {dbms: "val"}
liquibase.command.dbms
LIQUIBASE_COMMAND_DBMS

Specifies which database type a changeset is to be used for. See valid database type names on dbms. The keywords all and none are also available.

--default-catalog-name
cmdArgs: {default-catalog-name: "val"}
liquibase.command.defaultCatalogName
LIQUIBASE_COMMAND_DEFAULT_CATALOG_NAME

Name of the default catalog to use for the database connection

--default-schema-name
cmdArgs: {default-schema-name: "val"}
liquibase.command.defaultSchemaName
LIQUIBASE_COMMAND_DEFAULT_SCHEMA_NAME

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.

--diff-types
cmdArgs: {diff-types: "val"}
liquibase.command.diffTypes
LIQUIBASE_COMMAND_DIFF_TYPES

Specifies the types of objects to compare. Specify multiple values as a comma-separated list (without spaces). Valid values are: catalogs, checkconstraints, columns, data, databasepackage, databasepackagebody, foreignkeys, functions, indexes, primarykeys, sequences, storedprocedures, tables, triggers, uniqueconstraints, views.

If null, default types are columns, foreignkeys, indexes, primarykeys, tables, uniqueconstraints, views.

Note: The diff types checkconstraints, databasepackage, databasepackagebody, functions, storedprocedures, and triggers require a valid Liquibase Pro license key to use.

--drop-all-require-force
cmdArgs: {drop-all-require-force: "val"}
liquibase.command.dropAllrequireForce
LIQUIBASE_COMMAND_DROP_ALL_REQUIRE_FORCE

Specifies whether Liquibase requires the user to specify the --force parameter to use the drop-all command. Liquibase 4.27.0+. Default: false.

--exclude-objects
cmdArgs: {exclude-objects: "val"}
liquibase.command.excludeObjects
LIQUIBASE_COMMAND_EXCLUDE_OBJECTS

Objects to exclude from diff

--force-on-partial-changes
cmdArgs: {force-on-partial-changes: "val"}
liquibase.command.forceOnPartialChanges
LIQUIBASE_COMMAND_FORCE_ON_PARTIAL_CHANGES

Liquibase Pro only. Use this argument only if you are specifying --rollback-on-error=true to automatically roll back update operations containing errors. --force-on-partial-changes=true specifies whether Liquibase rolls back partially invalid changesets, such as a changeset containing two changes: one with an error and one without an error. This ensures that you can successfully roll back all changes if a deployment has an error, even if the changeset contains multiple changes. Available in Liquibase 4.25.0+. Default: false. See also: failOnError.

--include-catalog
cmdArgs: {include-catalog: "val"}
liquibase.command.includeCatalog
LIQUIBASE_COMMAND_INCLUDE_CATALOG

If true, the catalog will be included in generated changesets. Default: false

--include-objects
cmdArgs: {include-objects: "val"}
liquibase.command.includeObjects
LIQUIBASE_COMMAND_INCLUDE_OBJECTS

Objects to include in diff

--include-schema
cmdArgs: {include-schema: "val"}
liquibase.command.includeSchema
LIQUIBASE_COMMAND_INCLUDE_SCHEMA

If true, the schema will be included in generated changesets. Default: false

--include-tablespace
cmdArgs: {include-tablespace: "val"}
liquibase.command.includeTablespace
LIQUIBASE_COMMAND_INCLUDE_TABLESPACE

Include the tablespace attribute in the changelog. Default: false

--labels
cmdArgs: {labels: "val"}
liquibase.command.labels
LIQUIBASE_COMMAND_LABELS

Specifies the changeset labels to match. Labels are tags you can add to changesets to control which changesets will be executed in any migration run.

--output-directory
cmdArgs: {output-directory: "val"}
liquibase.command.outputDirectory
LIQUIBASE_COMMAND_OUTPUT_DIRECTORY

The directory where the database documentation is generated. Specify as --output-directory=exampleDirectory. Positional format <command> <directory> deprecated in 4.4+.

--output-schemas
cmdArgs: {output-schemas: "val"}
liquibase.command.outputSchemas
LIQUIBASE_COMMAND_OUTPUT_SCHEMAS

Lets you replace the schemas in the output changelog. This is a CSV list. The parameter size must match --schemas. If you have three items names in --schemas, you must also have three items in --output-schemas.

Example: liquibase generate-changelog --schemas=a,b,c --output-schemas=d,e,f

--overwrite-output-file
cmdArgs: {overwrite-output-file: "val"}
liquibase.command.overwriteOutputFile
LIQUIBASE_COMMAND_OVERWRITE_OUTPUT_FILE

Determines whether generate-changelog can overwrite an existing changelog, including one specified in --changelog-file. Default: false.

--reference-liquibase-catalog-name
cmdArgs: {reference-liquibase-catalog-name: "val"}
liquibase.command.referenceLiquibaseCatalogName
LIQUIBASE_COMMAND_REFERENCE_LIQUIBASE_CATALOG_NAME

Reference database catalog to use for Liquibase objects. Liquibase 4.24.0+.

--reference-liquibase-schema-name
cmdArgs: {reference-liquibase-schema-name: "val"}
liquibase.command.referenceLiquibaseSchemaName
LIQUIBASE_COMMAND_REFERENCE_LIQUIBASE_SCHEMA_NAME

Reference database schema to use for Liquibase objects. Liquibase 4.24.0+.

--replace-if-exists-types
cmdArgs: {replace-if-exists-types: "val"}
liquibase.command.replaceIfExistsTypes
LIQUIBASE_COMMAND_REPLACE_IF_EXISTS_TYPES

Specify Change Types you want to target. Liquibase sets replaceIfExists="true" on these Change Types: createFunction, createPackage, createPackageBody, createProcedure, createTrigger, and createView. Liquibase 4.26.0+. Default: <none>.

--rollback-on-error
cmdArgs: {rollback-on-error: "val"}
liquibase.command.rollbackOnError
LIQUIBASE_COMMAND_ROLLBACK_ON_ERROR

Liquibase Pro only. If any changeset in a deployment fails, --rollback-on-error stops the update operation and rolls back all changesets you just deployed. Available in Liquibase 4.18.0+. Default: false.

Note: A changeset marked failOnError=false does not trigger as an error, so rollback-on-error will not occur. Additionally, if a changeset is not auto-rollback compliant or does not have a rollback script, then rollback-on-error does not occur for any changeset. Read more: failOnError.

--rollback-script
cmdArgs: {rollback-script: "val"}
liquibase.command.rollbackScript
LIQUIBASE_COMMAND_ROLLBACK_SCRIPT

The path to the script to use to perform the rollback. Only needed if the rollback is not already defined in the changelog, and if it is not a rollback statement that is automatically generated by Liquibase.

--run-on-change-types
cmdArgs: {run-on-change-types: "val"}
liquibase.command.runOnChangeTypes
LIQUIBASE_COMMAND_RUN_ON_CHANGE_TYPES

Specify Change Types you want to target. Liquibase sets runOnChange="true" on changesets containing solely these Change Types: createFunction, createPackage, createPackageBody, createProcedure, createTrigger, and createView. Liquibase 4.26.0+. Default: <none>.

--schemas
cmdArgs: {schemas: "val"}
liquibase.command.schemas
LIQUIBASE_COMMAND_SCHEMAS

Database schemas to include objects from in reporting

Schemas to include in diff

Schemas to include in drop. You can drop multiple schemas using a comma separated list.

Specifies database schemas you want to include

Specifies schemas to be able to compare a multi-schema database to its snapshot

--show-summary
cmdArgs: {show-summary: "val"}
liquibase.command.showSummary
LIQUIBASE_COMMAND_SHOW_SUMMARY

Liquibase 4.24.0+. Produces a summary list of any changesets skipped and why they were skipped. Valid values are OFF, SUMMARY, and VERBOSE. In Liquibase Pro, SUMMARY and VERBOSE provide additional information about failed deployments. Default: SUMMARY.

Note: Liquibase may display one or multiple reasons for halting deployment of a changeset. If Liquibase cannot resolve a halting reason, it does not evaluate the changeset for other possible halting reasons.

--show-summary-output
cmdArgs: {show-summary-output: "val"}
liquibase.command.showSummaryOutput
LIQUIBASE_COMMAND_SHOW_SUMMARY_OUTPUT

Liquibase 4.24.0+. Summary output to report update summary results. Valid values are LOG, CONSOLE, and ALL. If set to LOG, the --show-summary output is sent to the file specified in --log-file. If set to CONSOLE, the --show-summary output is sent to STDOUT. If set to ALL, the --show-summary output is sent to both locations. Default: ALL.

--skip-object-sorting
cmdArgs: {skip-object-sorting: "val"}
liquibase.command.skipObjectSorting
LIQUIBASE_COMMAND_SKIP_OBJECT_SORTING

Liquibase 4.27.0+. Specifies how Liquibase sorts a list of objects in your database to generate a changelog. When true, Liquibase skips object sorting, so your objects are sorted according to the order returned by your database. This can be useful on databases that have a lot of packages or procedures that are linked to each other. When false, Liquibase sorts objects by dependency. This may avoid dependency errors. Default: false.

Note: If you set this parameter to true, Liquibase may create objects in the wrong order (such as a view on a table before the table itself), so you may have to manually reorganize the generated changelog file.

--snapshot-filters
cmdArgs: {snapshot-filters: "val"}
liquibase.command.snapshotFilters
LIQUIBASE_COMMAND_SNAPSHOT_FILTERS

Liquibase Pro 4.26.0+. Controls which types of objects Liquibase includes in the snapshot. Can improve command performance. Specify multiple values in a comma-separated list. Accepted values are: catalog, checkConstraint, column, databasePackage, databasePackageBody, foreignKey, function, index, primaryKey, schema, sequence, storedProcedure, synonym, table, trigger, uniqueConstraint, and view. Default: all types.

--snapshot-format
cmdArgs: {snapshot-format: "val"}
liquibase.command.snapshotFormat
LIQUIBASE_COMMAND_SNAPSHOT_FORMAT

Output format to use. Creates a file of the specified type that represents the current state of the database. Valid values: JSON, YAML, TXT. Default: TXT.

--sql
cmdArgs: {sql: "val"}
liquibase.command.sql
LIQUIBASE_COMMAND_SQL

The SQL string to execute

Note: Columns display in the same order they are specified in the argument. If no columns are specified (For example select * <table_name>), then the output will display columns in the same order they are in the database.

--sql-file
cmdArgs: {sql-file: "val"}
liquibase.command.sqlFile
LIQUIBASE_COMMAND_SQL_FILE

Specifies the file where SQL statements are stored

--tag
cmdArgs: {tag: "val"}
liquibase.command.tag
LIQUIBASE_COMMAND_TAG

The tag identifying which tagged changesets in the changelog to evaluate. Specify as --tag=myTag. Positional format <command> <tag> deprecated in 4.4+.

--tag-version
cmdArgs: {tag-version: "val"}
liquibase.command.tagVersion
LIQUIBASE_COMMAND_TAG_VERSION

Tag version to use for multiple occurrences of a tag. Valid values are NEWEST and OLDEST. If set to NEWEST, Liquibase rolls back changes up to the most recent instance of the tag. Any older instances of the tag remain in the DATABASECHANGELOG table. If set to OLDEST, Liquibase rolls back changes up to the first instance of the tag. Default: OLDEST

--verbose
cmdArgs: {verbose: "val"}
liquibase.command.verbose
LIQUIBASE_COMMAND_VERBOSE

Specifies the detail level of the command's output. Default: false.