update-one-changeset

--license-key=<string>

Your Liquibase Pro license key

--changelog-file=<string>

The root changelog

--changeset-author=<string>

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

--changeset-id=<string>

The changeset ID from the changelog.

--changeset-path=<string>

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.

--force=<true|false>

A required parameter which indicates you intend to use this feature. If you specify --force or --force=true, the command executes. If you omit the parameter or specify --force=false, the command does not execute. Default: false.

--url=<string>

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

--change-exec-listener-class=<string>

Fully-qualified class which specifies a ChangeExecListener. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.

--change-exec-listener-properties-file=<string>

Path to a properties file for the ChangeExecListener class. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.

--context-filter=<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 --contexts instead of --context-filter.

--default-catalog-name=<string>

Name of the default catalog to use for the database connection

--default-schema-name=<string>

Name of the default schema to use for the database connection. If defaultSchemaName is set, then objects do not have to be fully qualified. This means you can refer to just mytable instead of myschema.mytable.

Note: In the properties file and JAVA_OPTS only: in 4.18.0 and earlier, specify this parameter using the syntax defaultSchemaName. In 4.19.0 and later, use the syntax liquibase.command.defaultSchemaName.

Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set --preserve-schema-case to true. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a DatabaseException error if you specify a mixed-case value of defaultSchemaName. In 4.23.0 and later, the Liquibase validator accepts any casing.

--driver=<string>

The JDBC driver class

--driver-properties-file=<string>

The JDBC driver properties file

--force-on-partial-changes=<true|false>

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.

--label-filter=<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.

--password=<string>

Password to connect to the target database.

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

--report-enabled=<true|false>

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

--report-name=<string>

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=<string>

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

--report-suppress-exception=<true|false>

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=<true|false>

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.

--rollback-on-error=<true|false>

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.

--username=<string>

Username to connect to the target database.

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

globalArgs: { license-key: "<string>" }

Your Liquibase Pro license key

cmdArgs: { changelog-file: "<string>" }

The root changelog

cmdArgs: { changeset-author: "<string>" }

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

cmdArgs: { changeset-id: "<string>" }

The changeset ID from the changelog.

cmdArgs: { changeset-path: "<string>" }

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.

cmdArgs: { force: "<true|false>" }

A required parameter which indicates you intend to use this feature. If you specify --force or --force=true, the command executes. If you omit the parameter or specify --force=false, the command does not execute. Default: false.

cmdArgs: { url: "<string>" }

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

cmdArgs: { change-exec-listener-class: "<string>" }

Fully-qualified class which specifies a ChangeExecListener. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.

cmdArgs: { change-exec-listener-properties-file: "<string>" }

Path to a properties file for the ChangeExecListener class. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.

cmdArgs: { context-filter: "<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 --contexts instead of --context-filter.

cmdArgs: { default-catalog-name: "<string>" }

Name of the default catalog to use for the database connection

cmdArgs: { default-schema-name: "<string>" }

Name of the default schema to use for the database connection. If defaultSchemaName is set, then objects do not have to be fully qualified. This means you can refer to just mytable instead of myschema.mytable.

Note: In the properties file and JAVA_OPTS only: in 4.18.0 and earlier, specify this parameter using the syntax defaultSchemaName. In 4.19.0 and later, use the syntax liquibase.command.defaultSchemaName.

Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set --preserve-schema-case to true. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a DatabaseException error if you specify a mixed-case value of defaultSchemaName. In 4.23.0 and later, the Liquibase validator accepts any casing.

cmdArgs: { driver: "<string>" }

The JDBC driver class

cmdArgs: { driver-properties-file: "<string>" }

The JDBC driver properties file

cmdArgs: { force-on-partial-changes: "<true|false>" }

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.

cmdArgs: { label-filter: "<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.

cmdArgs: { password: "<string>" }

Password to connect to the target database.

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

cmdArgs: { report-enabled: "<true|false>" }

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

cmdArgs: { report-name: "<string>" }

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.

cmdArgs: { report-path: "<string>" }

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

cmdArgs: { report-suppress-exception: "<true|false>" }

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.

cmdArgs: { report-suppress-sql: "<true|false>" }

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.

cmdArgs: { rollback-on-error: "<true|false>" }

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.

cmdArgs: { username: "<string>" }

Username to connect to the target database.

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

liquibase.licenseKey: <string>

Your Liquibase Pro license key

liquibase.command.changelogFile: <string>

liquibase.command.updateOneChangeset.changelogFile: <string>

The root changelog

liquibase.command.changesetAuthor: <string>

liquibase.command.updateOneChangeset.changesetAuthor: <string>

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

liquibase.command.changesetId: <string>

liquibase.command.updateOneChangeset.changesetId: <string>

The changeset ID from the changelog.

liquibase.command.changesetPath: <string>

liquibase.command.updateOneChangeset.changesetPath: <string>

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.

liquibase.command.force: <true|false>

liquibase.command.updateOneChangeset.force: <true|false>

A required parameter which indicates you intend to use this feature. If you specify --force or --force=true, the command executes. If you omit the parameter or specify --force=false, the command does not execute. Default: false.

liquibase.command.url: <string>

liquibase.command.updateOneChangeset.url: <string>

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

liquibase.command.changeExecListenerClass: <string>

liquibase.command.updateOneChangeset.changeExecListenerClass: <string>

Fully-qualified class which specifies a ChangeExecListener. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.

liquibase.command.changeExecListenerPropertiesFile: <string>

liquibase.command.updateOneChangeset.changeExecListenerPropertiesFile: <string>

Path to a properties file for the ChangeExecListener class. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.

liquibase.command.contextFilter: <string>

liquibase.command.updateOneChangeset.contextFilter: <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 --contexts instead of --context-filter.

liquibase.command.defaultCatalogName: <string>

liquibase.command.updateOneChangeset.defaultCatalogName: <string>

Name of the default catalog to use for the database connection

liquibase.command.defaultSchemaName: <string>

liquibase.command.updateOneChangeset.defaultSchemaName: <string>

Name of the default schema to use for the database connection. If defaultSchemaName is set, then objects do not have to be fully qualified. This means you can refer to just mytable instead of myschema.mytable.

Note: In the properties file and JAVA_OPTS only: in 4.18.0 and earlier, specify this parameter using the syntax defaultSchemaName. In 4.19.0 and later, use the syntax liquibase.command.defaultSchemaName.

Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set --preserve-schema-case to true. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a DatabaseException error if you specify a mixed-case value of defaultSchemaName. In 4.23.0 and later, the Liquibase validator accepts any casing.

liquibase.command.driver: <string>

liquibase.command.updateOneChangeset.driver: <string>

The JDBC driver class

liquibase.command.driverPropertiesFile: <string>

liquibase.command.updateOneChangeset.driverPropertiesFile: <string>

The JDBC driver properties file

liquibase.command.forceOnPartialChanges: <true|false>

liquibase.command.updateOneChangeset.forceOnPartialChanges: <true|false>

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.

liquibase.command.labelFilter: <string>

liquibase.command.updateOneChangeset.labelFilter: <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.

liquibase.command.password: <string>

liquibase.command.updateOneChangeset.password: <string>

Password to connect to the target database.

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

liquibase.command.reportEnabled: <true|false>

liquibase.command.updateOneChangeset.reportEnabled: <true|false>

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

liquibase.command.reportName: <string>

liquibase.command.updateOneChangeset.reportName: <string>

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.

liquibase.command.reportPath: <string>

liquibase.command.updateOneChangeset.reportPath: <string>

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

liquibase.command.reportSuppressException: <true|false>

liquibase.command.updateOneChangeset.reportSuppressException: <true|false>

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.

liquibase.command.reportSuppressSql: <true|false>

liquibase.command.updateOneChangeset.reportSuppressSql: <true|false>

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.

liquibase.command.rollbackOnError: <true|false>

liquibase.command.updateOneChangeset.rollbackOnError: <true|false>

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.

liquibase.command.username: <string>

liquibase.command.updateOneChangeset.username: <string>

Username to connect to the target database.

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

JAVA_OPTS=-Dliquibase.licenseKey=<string>

Your Liquibase Pro license key

JAVA_OPTS=-Dliquibase.command.changelogFile=<string>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.changelogFile=<string>

The root changelog

JAVA_OPTS=-Dliquibase.command.changesetAuthor=<string>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.changesetAuthor=<string>

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

JAVA_OPTS=-Dliquibase.command.changesetId=<string>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.changesetId=<string>

The changeset ID from the changelog.

JAVA_OPTS=-Dliquibase.command.changesetPath=<string>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.changesetPath=<string>

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.

JAVA_OPTS=-Dliquibase.command.force=<true|false>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.force=<true|false>

A required parameter which indicates you intend to use this feature. If you specify --force or --force=true, the command executes. If you omit the parameter or specify --force=false, the command does not execute. Default: false.

JAVA_OPTS=-Dliquibase.command.url=<string>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.url=<string>

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

JAVA_OPTS=-Dliquibase.command.changeExecListenerClass=<string>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.changeExecListenerClass=<string>

Fully-qualified class which specifies a ChangeExecListener. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.

JAVA_OPTS=-Dliquibase.command.changeExecListenerPropertiesFile=<string>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.changeExecListenerPropertiesFile=<string>

Path to a properties file for the ChangeExecListener class. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.

JAVA_OPTS=-Dliquibase.command.contextFilter=<string>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.contextFilter=<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 --contexts instead of --context-filter.

JAVA_OPTS=-Dliquibase.command.defaultCatalogName=<string>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.defaultCatalogName=<string>

Name of the default catalog to use for the database connection

JAVA_OPTS=-Dliquibase.command.defaultSchemaName=<string>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.defaultSchemaName=<string>

Name of the default schema to use for the database connection. If defaultSchemaName is set, then objects do not have to be fully qualified. This means you can refer to just mytable instead of myschema.mytable.

Note: In the properties file and JAVA_OPTS only: in 4.18.0 and earlier, specify this parameter using the syntax defaultSchemaName. In 4.19.0 and later, use the syntax liquibase.command.defaultSchemaName.

Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set --preserve-schema-case to true. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a DatabaseException error if you specify a mixed-case value of defaultSchemaName. In 4.23.0 and later, the Liquibase validator accepts any casing.

JAVA_OPTS=-Dliquibase.command.driver=<string>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.driver=<string>

The JDBC driver class

JAVA_OPTS=-Dliquibase.command.driverPropertiesFile=<string>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.driverPropertiesFile=<string>

The JDBC driver properties file

JAVA_OPTS=-Dliquibase.command.forceOnPartialChanges=<true|false>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.forceOnPartialChanges=<true|false>

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.

JAVA_OPTS=-Dliquibase.command.labelFilter=<string>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.labelFilter=<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.

JAVA_OPTS=-Dliquibase.command.password=<string>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.password=<string>

Password to connect to the target database.

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

JAVA_OPTS=-Dliquibase.command.reportEnabled=<true|false>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.reportEnabled=<true|false>

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

JAVA_OPTS=-Dliquibase.command.reportName=<string>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.reportName=<string>

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.

JAVA_OPTS=-Dliquibase.command.reportPath=<string>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.reportPath=<string>

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

JAVA_OPTS=-Dliquibase.command.reportSuppressException=<true|false>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.reportSuppressException=<true|false>

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.

JAVA_OPTS=-Dliquibase.command.reportSuppressSql=<true|false>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.reportSuppressSql=<true|false>

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.

JAVA_OPTS=-Dliquibase.command.rollbackOnError=<true|false>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.rollbackOnError=<true|false>

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.

JAVA_OPTS=-Dliquibase.command.username=<string>

JAVA_OPTS=-Dliquibase.command.updateOneChangeset.username=<string>

Username to connect to the target database.

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

LIQUIBASE_LICENSE_KEY=<string>

Your Liquibase Pro license key

LIQUIBASE_COMMAND_CHANGELOG_FILE=<string>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_CHANGELOG_FILE=<string>

The root changelog

LIQUIBASE_COMMAND_CHANGESET_AUTHOR=<string>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_CHANGESET_AUTHOR=<string>

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

LIQUIBASE_COMMAND_CHANGESET_ID=<string>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_CHANGESET_ID=<string>

The changeset ID from the changelog.

LIQUIBASE_COMMAND_CHANGESET_PATH=<string>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_CHANGESET_PATH=<string>

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.

LIQUIBASE_COMMAND_FORCE=<true|false>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_FORCE=<true|false>

A required parameter which indicates you intend to use this feature. If you specify --force or --force=true, the command executes. If you omit the parameter or specify --force=false, the command does not execute. Default: false.

LIQUIBASE_COMMAND_URL=<string>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_URL=<string>

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

LIQUIBASE_COMMAND_CHANGE_EXEC_LISTENER_CLASS=<string>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_CHANGE_EXEC_LISTENER_CLASS=<string>

Fully-qualified class which specifies a ChangeExecListener. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.

LIQUIBASE_COMMAND_CHANGE_EXEC_LISTENER_PROPERTIES_FILE=<string>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_CHANGE_EXEC_LISTENER_PROPERTIES_FILE=<string>

Path to a properties file for the ChangeExecListener class. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.

LIQUIBASE_COMMAND_CONTEXT_FILTER=<string>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_CONTEXT_FILTER=<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 --contexts instead of --context-filter.

LIQUIBASE_COMMAND_DEFAULT_CATALOG_NAME=<string>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_DEFAULT_CATALOG_NAME=<string>

Name of the default catalog to use for the database connection

LIQUIBASE_COMMAND_DEFAULT_SCHEMA_NAME=<string>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_DEFAULT_SCHEMA_NAME=<string>

Name of the default schema to use for the database connection. If defaultSchemaName is set, then objects do not have to be fully qualified. This means you can refer to just mytable instead of myschema.mytable.

Note: In the properties file and JAVA_OPTS only: in 4.18.0 and earlier, specify this parameter using the syntax defaultSchemaName. In 4.19.0 and later, use the syntax liquibase.command.defaultSchemaName.

Note: In Liquibase 4.12.0 and later, you can use mixed-case schema names if you set --preserve-schema-case to true. However, in Liquibase 4.12.0–4.22.0, the Liquibase validator still throws a DatabaseException error if you specify a mixed-case value of defaultSchemaName. In 4.23.0 and later, the Liquibase validator accepts any casing.

LIQUIBASE_COMMAND_DRIVER=<string>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_DRIVER=<string>

The JDBC driver class

LIQUIBASE_COMMAND_DRIVER_PROPERTIES_FILE=<string>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_DRIVER_PROPERTIES_FILE=<string>

The JDBC driver properties file

LIQUIBASE_COMMAND_FORCE_ON_PARTIAL_CHANGES=<true|false>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_FORCE_ON_PARTIAL_CHANGES=<true|false>

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.

LIQUIBASE_COMMAND_LABEL_FILTER=<string>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_LABEL_FILTER=<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.

LIQUIBASE_COMMAND_PASSWORD=<string>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_PASSWORD=<string>

Password to connect to the target database.

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

LIQUIBASE_COMMAND_REPORT_ENABLED=<true|false>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_REPORT_ENABLED=<true|false>

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

LIQUIBASE_COMMAND_REPORT_NAME=<string>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_REPORT_NAME=<string>

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.

LIQUIBASE_COMMAND_REPORT_PATH=<string>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_REPORT_PATH=<string>

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

LIQUIBASE_COMMAND_REPORT_SUPPRESS_EXCEPTION=<true|false>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_REPORT_SUPPRESS_EXCEPTION=<true|false>

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.

LIQUIBASE_COMMAND_REPORT_SUPPRESS_SQL=<true|false>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_REPORT_SUPPRESS_SQL=<true|false>

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.

LIQUIBASE_COMMAND_ROLLBACK_ON_ERROR=<true|false>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_ROLLBACK_ON_ERROR=<true|false>

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.

LIQUIBASE_COMMAND_USERNAME=<string>

LIQUIBASE_COMMAND_UPDATE_ONE_CHANGESET_USERNAME=<string>

Username to connect to the target database.

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