Liquibase Parameters
Parameters allow you to specify additional behavior when running Liquibase Commands. They may take Booleans, strings, integers, or other types as values. You can:
- Enter properties as command-line arguments
- Create connection profiles or specify other parameters in the Liquibase properties file
- Specify global or command arguments in Liquibase flow file actions
- Use the
JAVA_OPTS
variable to pass custom settings to the Java Virtual Machine (JVM) that runs Liquibase - Use environment variables to securely pass sensitive data
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Liquibase supports the setting of properties from the following locations, from highest to lowest priority:
- Command-line arguments
ServletConfig
initialization parametersServletContext
initialization parameters- Java system properties
- OS environment variables
- Configuration data, such as piped standard input, defaults files, and connection profiles and other properties stored in the Liquibase properties file.
For example, command-line arguments override ServletConfig
and ServletContext
initialization parameters, Java system properties, OS environment variables, and configuration data, while OS environment variables override configuration data only.
The following tables describe the Liquibase parameters that are available as global or command-specific options. For more information, run liquibase --help
from the command prompt. To learn how to use parameters in more detail, see Working with Command Parameters.
Global
You can use global parameters with any Liquibase command.
Note: Syntax for each parameter is specified in kebab-case
(CLI and flow file), camelCase
(properties file and JAVA_OPTS
), and MACRO_CASE
(environment variable).
Tip: For best results, specify all commands and parameters in the --kebab-case
format in the CLI. If your preference is camelCase, it also works in the CLI.
Info
Syntax | Description |
---|---|
|
Opens the help menu. CLI-only. |
|
Print version information. CLI-only. |
General
Syntax (--cli , {flow-file} , propertiesFile , ENV_VAR ) |
Type | Description |
---|---|---|
|
Boolean | Specifies whether Liquibase lets you deploy multiple changesets with the same filepath, author, and ID. Liquibase 4.25.1+. Default: false . See allow-duplicated-changeset-identifiers. |
|
Boolean | If true , drops and recreates a view instead of replacing it. Only affects PostgreSQL databases. Default: false . See always-drop-instead-of-replace. |
|
String | 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. Default: false . See always-override-stored-logic-schema. |
|
Boolean | Defines whether Liquibase automatically reorganizes table objects stored on disk when you modify a DB2 database. Default: true . See auto-reorg. |
|
Integer | Specifies the number of seconds Liquibase waits to check if a changelog lock has been released. Default: 10 . See changelog-lock-poll-rate. |
|
Integer | Specifies the amount of time Liquibase waits for a locked database to become available. Default: 5 . See changelog-lock-wait-time-in-minutes. |
|
String | Configures how to handle unknown fields in changelog files. Possible values: STRICT (causes parsing to fail) and LAX (continues with the parsing). Default: STRICT . |
|
String | Specifies additional classpath entries to use. Use the format /path/to/your/additional/jars . Separate multiple JARs with : on UNIX and ; on Windows. For example: ./DatabricksJDBC42.jar:./liquibase-databricks-<version>.jar |
|
Boolean | Allows Liquibase to convert data types such as int , bigint , timestamp , and clob to the standard data types. Default: true . See convert-data-types. |
|
String | Specifies the name of a table to use for tracking concurrent Liquibase usage. Default: DATABASECHANGELOGLOCK . See database-changelog-lock-table-name. |
|
String | Specifies the name of a table to use for tracking change history. Default: DATABASECHANGELOG . See database-changelog-table-name. |
|
String | Specifies the class to use for a Database implementation. See database-class. |
|
Integer | Liquibase 4.6.2+. Indicates the number of seconds a DDL command should wait for the locks to become available before throwing the "resource busy" error message. This parameter applies only to Oracle databases. See ddl-lock-timeout. |
|
String | Specifies the file with default Liquibase properties. Default: liquibase.properties . |
|
Boolean | Defines whether Liquibase compares the column order in a diff operation. Default: true . See diff-column-order. |
|
String | Specifies the database driver class. See driver. |
|
String | Specifies a file with driver-specific properties. |
|
String | How to handle multiple files being found in the search path that have duplicate paths. Options are WARN (log warning and choose one at random) or ERROR (fail current operation). Default: ERROR . |
|
Boolean | Throw an error if Liquibase detects that an includeAll will cause a circular reference (and thus a changelog parse error). Default: true . See error-on-circular-include-all. |
|
String | Encoding to use when reading files. Valid values include: UTF-8 , UTF-16 , UTF-16BE , UTF-16LE , US-ASCII , or OS to use the system configured encoding. Default: UTF-8 . See file-encoding. |
|
Boolean | Determines whether Liquibase adds timestamps to changesets in the changelog it generates when you run the diff-changelog or generate-changelog commands. Default: false . See generate-changeset-created-values. |
|
String | Determines whether Liquibase includes changeset descriptions in changelogs generated with the generate-changelog command in addition to changeset IDs. Default: false . See generated-changeset-ids-contains-description. |
|
String | Forces Liquibase to run without access to the console for input and output. Default: false . See headless. |
|
Boolean | Defines whether Liquibase includes the catalog name when determining equality between the compared databases. Default: false . See include-catalog-in-specification. |
|
Boolean |
Specifies whether Liquibase commands like |
|
Boolean | Defines whether Liquibase includes the system classpath when resolving classes at runtime. Default: true . See include-system-classpath. |
|
String | Specifies Liquibase Pro license key that allows using all the functionality of Liquibase Open Source and Liquibase Pro. Deprecated: liquibase.pro.licenseKey . See How to Apply Your Liquibase Pro License Key. |
|
String | Specifies the catalog to use for Liquibase objects. See liquibase-catalog-name. |
|
String | Specifies the schema to use for the creation of Liquibase objects, like the DATABASECHANGELOG and DATABASECHANGELOGLOCK tracking tables. See liquibase-schema-name. |
|
String | Specifies the tablespace Liquibase uses to store objects that are being deployed to your database. See liquibase-tablespace-name. |
|
String | Controls which log channels have their level set by the liquibase.logLevel setting. Separate multiple values with commas. Example: liquibase,org.mariadb.jdbc . To set the level of all channels, use ALL . |
|
String | Sends logging messages of what Liquibase does during runtime to a file. See log-file. |
|
String |
Sets the format of log output to the console or to log files. Liquibase Open Source users default to unstructured |
|
String | Controls the amount of messages that are generated when running Liquibase commands. The official log levels are: OFF , SEVERE , WARNING , INFO , FINE . Default: SEVERE . See log-level. |
|
Boolean | When set to true , the console messages are mirrored to the logs as [liquibase.ui] to provide a more complete picture of Liquibase operations to log analysis tools. Set to false to change this behavior. Default: true . See mirror-console-messages-to-log. |
|
String | Specifies how to handle changelog property expressions where a value is not set. For example, a string null when no address property was defined. Values can be: PRESERVE , which leaves the string as-is; EMPTY , which replaces it with an empty string; or ERROR , which stops processing with an error. Default: PRESERVE . |
|
Boolean | Enables performance tracking. If true , data is stored to a liquibase-TIMESTAMP.jfr file in your working directory. Any other value will enable tracking and be used as the name of the file to write the data to. Default: false . See monitor-performance. |
|
String | Controls how Liquibase behaves when it cannot find a changelog specified in an include tag in the root changelog. Can be set to WARN or FAIL . See on-missing-include-changelog. |
|
String |
File path to where the command output will be written. If not specified, output goes to |
|
String | Determines which character encoding to use when writing Liquibase command outputs to external files. Default: UTF-8 . See output-file-encoding. |
|
String | Specifies the string that separates lines in STDOUT . Default: OS default line separator (LF or CRLF ). See output-line-separator. |
|
Boolean | Determines whether Liquibase treats schema and catalog names as case-sensitive. Default: false . |
|
String |
Specifies a default delimiter for all changesets. Liquibase 4.25.1+. Default: Tip: It is a best practice not to use |
|
Boolean |
Specifies whether the |
|
Boolean | Defines whether a column will be dropped when running diff-changelog or generate-changelog . If false , Liquibase continues to drop columns rather than marking them as unused. If true , creates the markUnused changes instead of the dropColumn changes and overrides the behavior. Default: false . |
|
Boolean | If true , Liquibase generates changesets with SQL-based changes embedded instead of saving them to an external file. Default: false . |
|
Boolean | If true , Liquibase checks for the existence of Liquibase Pro resource files that you've specified. Default: false . See pro-strict. |
|
Boolean | If false , Liquibase does not drop public synonyms in diff-changelog or drop-all . Default: true . |
|
Boolean | Determines whether Liquibase prompts you if you access a non-local database. Default: false . |
|
String | Implements the Properties class to provide additional driver properties. |
|
String | Specifies the locations to search for migration files in. Separate multiple paths with commas. See search-path. |
|
Boolean | Enables the validation of the custom XSD files. If true , removes functionality from file parsers which could be used insecurely. Examples include (but not limited to) disabling remote XML entity support. If you use custom XSD files, set this parameter to false . (Liquibase 4.8.0 and later versions). Default: true . |
|
Boolean | Determines whether Liquibase commands execute. Default: true . See should-run. |
|
Boolean | Determines whether Liquibase snapshots your database data. Default: false . See should-snapshot-data. |
|
Boolean | If true , shows a Liquibase banner on startup. Default: true . |
|
String | Defines the level of logging for SQL statements. Valid values are <FINE|INFO|WARNING|SEVERE|OFF> . 4.6.2+. Default: FINE . See sql-log-level. |
|
Boolean | Specifies whether Liquibase logs should include Java SQLWarning messages. Available in 4.25.0+. Default: true . See sql-show-sql-warnings. |
|
Boolean | If true , Liquibase enforces certain best practices and proactively looks for common errors. Default: false . See strict. |
|
Boolean | If true , Liquibase supports escaping changelog parameters using a colon. Example: ${:user.name} . Default: false . |
|
String | Liquibase 4.29.0+. Controls the level of validation to check if a change's supports() method is properly implemented. Valid values are OFF , WARN , and FAIL . Default: WARN . See supports-method-validation-level. |
|
Boolean | Liquibase 4.29.0+. Trims whitespace from CSV headers that you call with the loadData Change Type. Default: false . See trim-load-data-file-header. |
|
String | Specifies the default UI service logger used by Liquibase. Valid values are CONSOLE and LOGGER . The default value is CONSOLE . Default: CONSOLE . Available in Liquibase 4.25.0+. See ui-service. |
|
Boolean | If true , any createProcedure tags with a set schemaName will modify the procedure body with the given schema name. Default: true . |
|
Boolean | If true , will perform XSD validation of XML changelog files. When many XML changelog files are
included, this validation may impact Liquibase performance. Default: true . See validate-xml-changelog-files. |
DATABASECHANGELOGHISTORY table
For more information, see DATABASECHANGELOGHISTORY table and dbcl-history
.
Parameter | Typ | Definition |
---|---|---|
|
Boolean |
If |
|
Boolean |
If |
|
Boolean |
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: |
|
String |
The exit code for Liquibase to return if an exception is encountered while recording events to the DATABASECHANGELOGHISTORY table. Valid values are |
Executors
For more information, see runWith.
Syntax (--cli , {flow-file} , propertiesFile , ENV_VAR ) |
Type | Description |
---|---|---|
|
String |
Defines extra arguments to pass to the Note: The delimiter for arguments is a space |
|
Boolean |
Indicates whether or not to keep a temporary SQL file after the execution of |
|
String |
Indicates the name of a temporary SQL file after the execution of |
|
String |
Specify the path in which to store the temporary files after the execution of |
|
String |
Log file for |
|
String |
Path to |
|
Integer |
Indicates seconds to wait for the |
|
String |
Defines extra arguments to pass to the Note: The delimiter for arguments is a space |
|
String |
Database to use when running SQLCMD. |
|
Boolean |
Indicates whether or not to keep a temporary SQL file after the execution of |
|
String |
Indicates the name of a temporary SQL file after the execution of |
|
Boolean |
Overwrites any files in the specified directory with the same name. Default: |
|
String |
Specify the path in which to store the temporary files after the execution of |
|
String |
Log file for |
|
String |
Path to |
|
Integer |
Indicates seconds to wait for the |
|
String |
Defines extra arguments to pass to the Note: The delimiter for arguments is a space |
|
Boolean |
If |
|
Boolean |
Indicates whether or not to keep a temporary SQL file after the execution of |
|
String |
Indicates the name of a temporary SQL file after the execution of |
|
Boolean |
Overwrites any files in the specified directory with the same name. Default: |
|
String |
Specify the path in which to store the temporary files after the execution of |
|
String |
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. |
|
String |
Path to |
|
String |
Control the outcome when Liquibase returns a SQL error. The error clause is passed directly to Oracle. Default:
|
|
Integer |
Indicates seconds to wait for the |
|
String |
Liquibase 4.29.2+. Username to use with the native executor, such as |
Operation Reports
For more information, see Operation Reports.
Syntax (--cli , {flow-file} , propertiesFile , ENV_VAR ) |
Type | Description | Requirement |
---|---|---|---|
|
Boolean | Enables or disables all reports at the global level. Overridden by --report-enabled at the command level. Default: false . |
Required (either this or --report-enabled ) |
|
String | 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 . |
Optional |
|
String | Specifies the file path to the report file at the global level. Overridden by --report-path at the command level. Default: ./ |
Optional |
Structured Logging
For more information, see Structured Logging and Custom and Private Data in Structured Logs.
Syntax (--cli , {flow-file} , propertiesFile , ENV_VAR ) |
Type | Description |
---|---|---|
|
String | Specifies the file that contains the custom data that can be included or excluded from Structured Logs. Available in Liquibase 4.23.2+. See custom-log-data-file. |
|
String | Specifies the frequency that custom log data will be included in Structured Logs. Valid values are: ONCE , REPEATED . Default: REPEATED . Available in Liquibase 4.24.0+. See custom-log-data-frequency. |
Extensions
Amazon DynamoDB
For more information, see Liquibase Parameters for Amazon DynamoDB Pro and Using Liquibase with Amazon DynamoDB Pro.
Name (--cli , {flow-file} , propertiesFile , ENV_VAR ) |
Type | Description |
---|---|---|
Read more: |
String |
Initial billing mode for Liquibase tracking tables (DBCL and DBCLL). This controls how you pay for database read/write operations and capacity. Valid values: Note: If you want to change the billing mode of the tracking tables after you create them, you must instead use the
|
Read more: |
Integer |
Specifies how many Note: If you want to change the provisioned throughput values of the tracking tables after you create them, you must instead use the
|
Read more: |
Integer |
Specifies how many Note: If you want to change the provisioned throughput values of the tracking tables after you create them, you must instead use the
|
Read more: |
Boolean |
Specifies whether to enable or disable the Warning: If you set this parameter to |
Read more: |
Boolean |
Specifies whether Liquibase fails if the |
Read more: |
Boolean |
Specifies whether Liquibase sends you periodic status notifications while the |
Read more: |
Integer |
Specifies the interval in milliseconds for Liquibase to wait between sending status notifications while the |
Read more: |
Integer |
Number of seconds for the |
Read more: |
Integer |
Maximum number of attempts for the |
Read more: |
Integer |
Total number of seconds for the |
Read more: |
Integer |
Number of seconds for the |
Read more: |
Integer |
Maximum number of attempts for the |
Read more: |
Integer |
Total number of seconds for the |
Read more: |
Integer |
Number of seconds for the |
Read more: |
Integer |
Maximum number of attempts for the |
Read more: |
Integer |
Total number of seconds for the |
MongoDB Pro
For more information, see Using Liquibase MongoDB Pro with MongoDB Platforms.
Syntax (--cli , {flow-file} , propertiesFile , ENV_VAR ) |
Type | Description |
---|---|---|
|
Boolean | Enabling this property will validate History Change Log and Log Lock Collections on Startup and adjust if are not up to date with current release. Worth keeping it disabled and re-enable when upgraded to a new Liquibase version. Default: true . |
|
Boolean | Setting this property to false will add retryWrites=false to connection URL. This will permit usage on Mongo Versions not supporting retryWrites , like Amazon DocumentDB. Default: true . |
|
Boolean | Disabling this property will let create the Tracking Collections without validators. This will permit usage on Mongo Versions not supporting Validators. Default: true . |
Configuration
Note: Before Liquibase 4.25.0, the following configuration properties can only be set as operating system environment variables (such as LIQUIBASE_HOME
). In Liquibase 4.25.0+, you can set these with the JAVA_OPTS Environment Variable (such as liquibase.home
) like other Liquibase parameters on this page.
Syntax (JAVA_OPTS , ENV_VAR ) |
Type | Description |
---|---|---|
|
String |
The directory that points to the Liquibase installation location. |
|
String |
Enables the Liquibase debug mode, which produces more log output and allows the user to debug their database. |
|
String |
The classloader that runs Liquibase via either system or thread. This variable defaults to system. |
Deprecated
Syntax (--cli , {flow-file} , propertiesFile , ENV_VAR ) |
Type | Description |
---|---|---|
|
String | [Deprecated] Specifies a default logging level. Default: INFO . |
|
Boolean | [Deprecated] Defines whether Liquibase filters log messages for potentially insecure data. Default: true . See filter-log-messages. |
|
String | [Deprecated] Name of a custom executor you can specify. |
Command parameters
You can use command parameters with only certain commands or groups of commands.
Note: Syntax for each parameter is specified in kebab-case
(CLI and flow file), camelCase
(properties file and JAVA_OPTS
), and MACRO_CASE
(environment variable).
Tip: For best results, specify all commands and parameters in the --kebab-case
format in the CLI. If your preference is camelCase, it also works in the CLI.
Property substitution
For more information, see Substituting Properties in Changelogs.
Syntax | Description |
---|---|
|
CLI only. Pass a name/value pair for substitution in the changelog(s). Pass as -D<property.name>=<property.value> . On Windows, surround the property name in quotation marks if it contains a dot. For example: -D"property.name"=value . |
Connection profile
Syntax (--cli , {flow-file} , propertiesFile , ENV_VAR ) |
Type | Description |
---|---|---|
|
String | Specifies the root changelog file to execute. |
|
String |
The JDBC driver class |
|
String |
The JDBC driver properties file |
|
String |
Password to connect to the target database. Tip: It is a best practice to store sensitive data in a Secrets Management tool with Liquibase Pro. |
|
String |
The reference default catalog name to use for the database connection |
|
String |
The reference default schema name to use for the database connection |
|
String |
The JDBC driver class for the reference database |
|
String |
The JDBC driver properties file for the reference database |
|
String |
The reference database password. Tip: It is a best practice to store sensitive data in a Secrets Management tool with Liquibase Pro. |
|
String |
Schemas names on reference database to use in diff. This is a CSV list. |
|
String |
The JDBC reference database connection URL |
|
String |
The reference database username. Tip: It is a best practice to store sensitive data in a Secrets Management tool with Liquibase Pro. |
|
String |
The JDBC database connection URL. See Using JDBC URL in Liquibase. |
|
String |
Username to connect to the target database. Tip: It is a best practice to store sensitive data in a Secrets Management tool with Liquibase Pro. |
init
For more information, see Init Commands.
Syntax (--cli , {flow-file} , propertiesFile , ENV_VAR ) |
Type | Description |
---|---|---|
|
Boolean |
Recursively copy files from the source directory. Default: |
|
String |
Source directory where the project files will be copied from. Default: |
|
String |
Path to the directory where the project files will be created |
|
String |
Relative or fully qualified path to the changelog
file. Default: |
|
String |
Format of the project changelog file: |
|
Boolean |
For remote project locations, do not delete
temporary project files. Default: |
|
String |
Password to use to connect to the database. Default: |
|
String |
File with default Liquibase properties. Default: |
|
String |
An optional parameter used to specify the directory
containing files (existing or to be auto-created)
to be used with Liquibase.
Default: |
|
String |
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 |
|
String |
The JDBC database connection URL. See Using JDBC URL in Liquibase. Default: |
|
String |
Username to connect to the database. Default: |
|
String |
Network address to bind to. Default: |
|
String |
Port to run h2 database on. Default: |
|
Boolean |
Whether to open a browser to the database's web interface. Default: |
|
String |
Password to use for created h2 user. Default: |
|
String |
Username to create in h2. Default: |
|
String |
Port to run h2's web interface on. Default: |
Flow Files
For more information, see Liquibase Flow Files.
Syntax (--cli , {flow-file} , propertiesFile , ENV_VAR ) |
Type | Description |
---|---|---|
|
String |
The path to the configuration YAML file which
contains one or more "stages" of commands to be
executed in a |
|
Boolean |
If true, parse flow file YAML to allow only Liquibase flow file-specific properties, indentations, and
structures.
Default: |
|
String |
The default interpreter used to execute shell
commands. Examples include |
|
Boolean |
If true, do not delete temporary files created by the shell
command execution.
Default: |
Quality checks
For more information, see Quality Checks.
Syntax (--cli , {flow-file} , propertiesFile , ENV_VAR ) |
Type | Description |
---|---|---|
|
Boolean |
Automatically enable new quality checks in |
|
String |
Allows automatic backup and updating of the |
|
Boolean |
If |
|
String |
The changelog file against which you execute checks when running |
|
String |
Specifies whether quality checks run on |
|
String |
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 |
|
String |
Allow changeset's rollback code to be analyzed for compliance with currently enabled quality checks. Default: |
|
String |
Only show the checks that are in the specified status. Valid values are |
|
String |
Specify which parts of the checks run output should be shown. Options:
Default: |
|
String |
If using a checks packages file, optionally specify which packages should be run from the file as a comma-separated list. |
|
String |
The Liquibase component to run checks against, which can be a comma-separated list. Valid values are |
|
String |
Specifies the checks settings file to use with 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. |
|
Boolean |
Disable all qualifying checks in the checks settings file. Default: |
|
Boolean |
Enable all qualifying checks in the checks settings file. Default: |
|
Boolean |
If |
|
String |
Sets the format of the check output to text or JSON. Valid values are |
|
String |
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 |
|
String |
The relative or fully qualified path and filename of the YAML file to create. Default: |
|
String |
The name of the checks package object to be created inside the checks package YAML file. |
|
Boolean |
If set to |
|
String |
The schemas to check when |
|
String |
Set the severity to return a code of 0–4 when the check is triggered. Default: |
|
String |
Only show the specified columns. Column options: |
|
String |
Specifies the severity value returned when a check fails due to a SQL parse error. Valid values are the following return codes:
Default: severity of the executed check |
|
String |
The JDBC database connection URL. See Using JDBC URL in Liquibase. |
Note: Some generic command parameters that work with quality check commands, like --default-catalog-name
, are not listed in this table. They are listed elsewhere on this page.
Operation Reports
For more information, see Operation Reports.
Syntax (--cli , {flow-file} , propertiesFile , ENV_VAR ) |
Type | Description |
---|---|---|
|
String |
Specifies the severity level of all error types in the drift report (changed, missing, or unexpected content). Valid values are |
|
String |
Specifies the severity level of changed content in the drift report. Valid values are |
|
String |
Specifies the severity level of missing content in the drift report. Valid values are |
|
String |
Specifies the severity level of unexpected content in the drift report. Valid values are |
|
Boolean |
If Note: Prior to Liquibase 4.29.0, this parameter was called |
|
Boolean |
Enables a report at the command level. Overrides the global argument |
|
String |
Specifies the name of the report file at the command level. Overrides the global argument |
|
String |
Specifies the file path to the report file at the command level. Overrides the global argument |
General
Syntax (--cli , {flow-file} , propertiesFile , ENV_VAR )test |
Type | Description |
---|---|---|
|
Boolean |
Liquibase Pro only. If 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. |
|
String | Includes a fully-qualified class which specifies ChangeExecListener. See Implementing a Custom ChangeExecListener Class with Liquibase. |
|
String | Specifies the path to a properties file for ChangeExecListenerClass . |
|
String |
Author of the changeset. Available in Liquibase 4.25.0+. Cannot be used with |
|
String |
ID of the changeset. Available in Liquibase 4.25.0+. Cannot be used with |
|
String |
Tag defined as a number or a descriptive name that is unique to each changeset. Requires the following format: In 4.25.0+, you can either specify Only valid for the |
|
String |
Path of the changelog that contains the changeset. Available in Liquibase 4.25.0+. Cannot be used with |
|
String |
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 |
|
Integer | Specifies the number of changes for which to generate SQL. |
|
String |
Specifies a directory to send the data output of the command as a CSV file. |
|
Datetime |
The date and time your database rolls back to.
The date format is |
|
Boolean |
If |
|
String |
Specifies which database type a changeset is to be used for. See valid database type names on Liquibase Database Tutorials. The keywords |
|
String |
Name of the default catalog to use for the database connection |
|
String |
Name of the default schema to use for the database connection. If Tip: In Liquibase v4.23.0+, camelCase for Note: The syntax |
|
String |
Specifies the types of objects to compare. Specify multiple values as a comma-separated list (without spaces). Valid values are: If null, default types are Note: The diff types |
|
Boolean |
Specifies whether Liquibase requires the user to specify the |
|
String |
Objects to exclude from diff |
|
Boolean |
Liquibase Pro only. Use this argument only if you are specifying |
|
Boolean |
If |
|
String |
Objects to include in diff |
|
Boolean |
If |
|
Boolean |
Include the tablespace attribute in the changelog. Default: |
|
String |
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. |
|
String |
The directory where the database documentation is generated. Specify as |
|
String |
Lets you replace the schemas in the output changelog. This is a CSV list. The parameter size must match Example: |
|
Boolean |
Determines whether |
|
String |
Reference database catalog to use for Liquibase objects. Liquibase 4.24.0+. |
|
String |
Reference database schema to use for Liquibase objects. Liquibase 4.24.0+. |
|
String |
Specify Change Types you want to target. Liquibase sets |
|
Boolean |
Liquibase Pro only. If any changeset in a deployment fails, Note: A changeset marked |
|
String |
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. |
|
String |
Specify Change Types you want to target. Liquibase sets |
|
String |
Database schemas to include objects from in reporting Schemas to include in diff Schemas to include in drop Specifies database schemas you want to include Specifies schemas to be able to compare a multi-schema database to its snapshot |
|
String |
Produces a summary list of any changesets skipped and why they were skipped. Valid values are 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. |
|
String |
Summary output to report update summary results. Valid values are |
|
Boolean |
Liquibase 4.27.0+. Specifies how Liquibase sorts a list of objects in your database to generate a changelog. When Note: If you set this parameter to |
|
String |
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: |
|
String |
Output format to use. Creates a file of the specified type that represents the current state of the database. Valid values: |
|
String |
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 |
|
String |
Specifies the file where SQL statements are stored |
|
String |
The tag identifying which tagged changesets in the changelog to evaluate. Specify as |
|
String |
Tag version to use for multiple occurrences of a tag. Valid values are |
|
Boolean |
Specifies the detail level of the command's output. Default: |