Command Parameters
The following tables describe the Liquibase parameters that are available as global or command-specific options. For more information, see Liquibase Commands or run liquibase --help
from the command prompt.
Global
--always-override-stored-logic-schema
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description When generating SQL for |
--auto-reorg
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter defines whether Liquibase automatically reorganizes table objects stored on disk when you modify a DB2 database. |
--changelog-lock-poll-rate
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the number of seconds Liquibase waits to check if a changelog lock has been released. |
--changelog-lock-wait-time-in-minutes
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the amount of time Liquibase waits for a locked database to become available. |
--classpath
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies additional classpath entries to use. |
--convert-data-types
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter allows Liquibase to convert |
--database-changelog-lock-table-name
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the name of a table to use for tracking concurrent Liquibase usage. |
--database-changelog-table-name
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the name of a table to use for a tracking change history. |
--database-class
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the class to use for a Database implementation. |
--ddl-lock-timeout
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter 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. |
--defaultlogger-level
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies a default logging level. |
--defaults-file
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the file with default Liquibase properties. |
--diff-column-order
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter defines whether Liquibase compares the column order in a diff operation. |
--driver
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the database driver class. |
--driver-properties-file
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies a file with driver-specific properties. |
--file-encoding=ASCII
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter defines the file encoding. |
--filter-log-messages
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter defines whether Liquibase filters log messages for potentially insecure data. |
--generate-changeset-created-values
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter determines whether Liquibase adds timestamps to changesets in the changelog it generates when you run the |
--generated-changeset-ids-contains-description
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter determines whether Liquibase includes changeset descriptions in changelogs generated with the |
--headless
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter can force Liquibase to run without access to the console for input and output. |
--hub-api-key
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies Liquibase Hub API key for operations. |
--hub-log-level
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the log level for filtering log messages to send to Liquibase Hub during operations. |
--hub-mode
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the content to send to Liquibase Hub during operations. Values can be |
--hub-url
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies Liquibase Hub URL for operations. |
--include-catalog-in-specification
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter defines whether Liquibase includes the catalog name when determining equality between the compared databases. |
--include-system-classpath
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter defines whether Liquibase includes the system classpath when resolving classes at runtime. |
--liquibase-catalog-name
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the catalog to use for Liquibase objects. |
--liquibase-schema-name
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the schema to use for the creation of Liquibase objects, like the DATABASECHANGELOG and DATABASECHANGELOGLOCK tracking tables. |
--liquibase-tablespace-name
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the tablespace Liquibase uses to store objects that are being deployed to your database. |
--log-file
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter sends logging messages of what Liquibase does during runtime to a file. |
--log-level
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter controls the amount of messages that are generated when running Liquibase commands. |
--output-file
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter sends your command output to a file. |
--output-file-encoding
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter determines which character encoding to use when writing Liquibase command outputs to external files. |
--output-line-separator
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the string that separates lines in |
--pro-license-key
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies Liquibase Pro license key that allows using all the functionality of Liquibase Community and Liquibase Pro. |
--pro-mark-unused-not-drop
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter defines whether a column will be dropped when running
|
--pro-sql-inline
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter generates changesets with SQL-based changes embedded instead of saving them to an external file if the value is set to |
--pro-synonyms-drop-public
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter does not drop public synonyms in |
--property-provider-class
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter implements the |
--should-run
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter determines whether Liquibase commands should run. |
--should-snapshot-data
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter allows Liquibase to snapshot your database data. |
--secure-parsing
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter enables the validation of the custom XSD files. The default value is |
--support-property-escaping
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter supports escaping changelog parameters using a colon. Example: |
--sql-log-level
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter defines the level of logging for SQL statements. The default value is |
--sqlplus-args
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter defines extra arguments to pass to the |
--sqlplus-keep-temp
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter indicates whether or not to keep a temporary SQL file after the execution of SQL Plus. If |
--sqlplus-keep-temp-name
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description [Optional] The parameter indicates the name of a temporary SQL file after the execution of SQL Plus. |
--sqlplus-keep-temp-overwrite
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description [Optional] The parameter overwrites any files in the specified directory with the same name. Default: |
--sqlplus-keep-temp-path
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description [Optional] The indicate the location to store a temporary SQL file after the execution of SQL Plus. If not specified, the files are stored in the system's |
--sqlplus-path
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter indicates the path to the |
--sqlplus-timeout
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter indicates seconds to wait for the
|
--sqlcmd-args
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter defines extra arguments to pass to the |
--sqlcmd-keep-temp
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter indicates whether or not to keep a temporary SQL file after the execution of SQLCMD. If |
--sqlcmd-keep-temp-name
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description [Optional] The parameter indicates the name of a temporary SQL file after the execution of SQLCMD. |
--sqlcmd-keep-temp-overwrite
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description [Optional] The parameter overwrites any files in the specified directory with the same name. Default: |
--sqlcmd-keep-temp-path
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description [Optional] The indicate the location to store a temporary SQL file after the execution of SQLCMD. If not specified, the files are stored in the system's |
--sqlcmd-path
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter indicates the path to the |
--sqlcmd-timeout
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter indicates seconds to wait for the
|
--strict
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter to restrict Liquibase configuration and setup. Default: |
--use-procedure-schema
|
Global | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description If the parameter is set to |
Command
--change-exec-listener-class
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter includes a fully-qualified class which specifies ChangeExecListener. See Implementing a Custom ChangeExecListener Class with Liquibase. |
--change-exec-listener-properties-file
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the path to a properties file for |
--changelog-file
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the root changelog file to execute. |
--changeset-identifier
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the changeset ID identifier of the form |
--checks-settings-file
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter which specifies the needed checks settings file to work with checks subcommands. For more information, see Using the Checks Settings Configuration File. |
--check-name
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter which allows any of the following subcommands being executed to perform its function:
|
--contexts
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the changeset contexts to match. Contexts in Liquibase are expressions you can add to changesets to control which will be executed in any particular migration run. |
--count
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the number of changes for which to generate SQL. |
--data-output-directory
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the directory to which Liquibase writes a table data. |
--date
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the date to which Liquibase can roll back changes. |
--default-catalog-name
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the default catalog name to use for the database connection. |
--default-schema-name
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the default schema name to use for the database connection. |
--delimiter
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the delimiter to use when executing the SQL script. |
--diff-types
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies types of objects to compare. |
--driver
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the JDBC driver class. |
--driver-properties-file
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the JDBC driver properties file. |
--exclude-objects
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies objects to exclude from the |
--hub-connection-id
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter identifies the specific target in which to record your data at Liquibase Hub. The parameter is available in your Project at https://hub.liquibase.com. |
--hub-project-id
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter identifies the specific Project in which to record your data at Liquibase Hub. The parameter is available in your account at https://hub.liquibase.com. |
--hub-project-name
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the Liquibase Hub project name. |
--include-objects
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies objects to include in the |
--labels
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the changeset labels to match. Labels in Liquibase are tags that you can add to changesets to control which changeset will be executed in any migration run. |
--output-directory
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the directory where the documentation is generated. |
--overwrite-output-file
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter allows you to overwrite the output changelog file. |
--password
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the password to use for connection to the target database. |
--reference-default-catalog-name
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the default catalog name to use for the reference database connection. |
--reference-default-schema-name
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the default schema name to use for the reference database connection. |
--reference-password
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the password to use for connection to the reference database. |
--reference-url
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the JDBC reference database connection URL. |
--reference-username
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the username to use for connection to the reference database. |
--rollback-script
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the rollback script to execute. |
--schemas
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies schemas to include in the |
--snapshot-format
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the output format to use for a snapshot (JSON or YAML). |
--sql
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the SQL string to execute. |
--sql-File
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the file where SQL statements are stored. |
--tag
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the tag to which Liquibase can generate SQL. |
--url
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the JDBC database connection URL. |
--username
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the username to use for connection to the target database. |
--verbose
|
Command | |
---|---|---|
Properties string
Environment variable
|
CLI
|
Description The parameter specifies the verbose flag which provides additional details. |