`update-testing-rollback`

update-testing-rollback tests rollback support by deploying all pending changesets to the database, executes a rollback sequentially for the equal number of changesets that were deployed, and then runs the update again deploying all changesets to the database.

Uses

update-testing-rollback is typically used when you want to test rollback functionality when deploying changesets in your changelog sequentially. Run this command only when all pending changelogs have been verified as ready to be deployed as you cannot specify changesets to exclude.

update-testing-rollback utilizes a multi-step operation and runs in sequential order:

update changeset1; update changeset2; update changeset3
rollback changeset3; rollback changeset2; rollback changeset1
update changeset1; update changeset2 update changeset3

Note: If you use the earlier versions of Liquibase, the order of operations may differ.

If any of the changesets fail rollback, changesets that come after the failed changesets will not be tested or updated. Any changesets that come before the failed changesets will be deployed to the database.

Syntax

To run the update-testing-rollback command, specify the driver, classpath, and URL in the Liquibase properties file. For more information, see Create and Configure a liquibase.properties File. You can also specify properties from the command line.

Then run the update-testing-rollback command:

liquibase update-testing-rollback --changelog-file=example-changelog.xml

Command parameters

Attribute	Definition	Requirement
`--changelog-file=<string>`	The root changelog	Required
`--url=<string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase.	Required
`--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.	Optional
`--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.	Optional
`--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`.	Optional
`--default-catalog-name=<string>`	Name of the default catalog to use for the database connection	Optional
`--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`. Tip: In Liquibase v4.23.0+, camelCase for `defaultSchemaName` works successfully. If you are on an earlier version, camelCase may not work as expected. Note: The syntax `liquibase.command.defaultSchemaName` is valid for v4.19.0+. For prior versions, use `defaultSchemaName`.	Optional
`--driver=<string>`	The JDBC driver class	Optional
`--driver-properties-file=<string>`	The JDBC driver properties file	Optional
`--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`.	Optional
`--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.	Optional
`--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.	Optional
`--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`.	Optional
`--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.	Optional

Attribute	Definition	Requirement
`cmdArgs: { changelog-file: "<string>" }`	The root changelog	Required
`cmdArgs: { url: "<string>" }`	The JDBC database connection URL. See Using JDBC URL in Liquibase.	Required
`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.	Optional
`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.	Optional
`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`.	Optional
`cmdArgs: { default-catalog-name: "<string>" }`	Name of the default catalog to use for the database connection	Optional
`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`. Tip: In Liquibase v4.23.0+, camelCase for `defaultSchemaName` works successfully. If you are on an earlier version, camelCase may not work as expected. Note: The syntax `liquibase.command.defaultSchemaName` is valid for v4.19.0+. For prior versions, use `defaultSchemaName`.	Optional
`cmdArgs: { driver: "<string>" }`	The JDBC driver class	Optional
`cmdArgs: { driver-properties-file: "<string>" }`	The JDBC driver properties file	Optional
`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`.	Optional
`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.	Optional
`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.	Optional
`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`.	Optional
`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.	Optional

Attribute	Definition	Requirement
`liquibase.command.changelogFile: <string>` `liquibase.command.<cmdName>.changelogFile: <string>`	The root changelog	Required
`liquibase.command.url: <string>` `liquibase.command.<cmdName>.url: <string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase.	Required
`liquibase.command.changeExecListenerClass: <string>` `liquibase.command.<cmdName>.changeExecListenerClass: <string>`	Fully-qualified class which specifies a `ChangeExecListener`. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.	Optional
`liquibase.command.changeExecListenerPropertiesFile: <string>` `liquibase.command.<cmdName>.changeExecListenerPropertiesFile: <string>`	Path to a properties file for the `ChangeExecListener` class. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.	Optional
`liquibase.command.contextFilter: <string>` `liquibase.command.<cmdName>.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`.	Optional
`liquibase.command.defaultCatalogName: <string>` `liquibase.command.<cmdName>.defaultCatalogName: <string>`	Name of the default catalog to use for the database connection	Optional
`liquibase.command.defaultSchemaName: <string>` `liquibase.command.<cmdName>.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`. Tip: In Liquibase v4.23.0+, camelCase for `defaultSchemaName` works successfully. If you are on an earlier version, camelCase may not work as expected. Note: The syntax `liquibase.command.defaultSchemaName` is valid for v4.19.0+. For prior versions, use `defaultSchemaName`.	Optional
`liquibase.command.driver: <string>` `liquibase.command.<cmdName>.driver: <string>`	The JDBC driver class	Optional
`liquibase.command.driverPropertiesFile: <string>` `liquibase.command.<cmdName>.driverPropertiesFile: <string>`	The JDBC driver properties file	Optional
`liquibase.command.forceOnPartialChanges: <true\|false>` `liquibase.command.<cmdName>.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`.	Optional
`liquibase.command.labelFilter: <string>` `liquibase.command.<cmdName>.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.	Optional
`liquibase.command.password: <string>` `liquibase.command.<cmdName>.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.	Optional
`liquibase.command.rollbackOnError: <true\|false>` `liquibase.command.<cmdName>.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`.	Optional
`liquibase.command.username: <string>` `liquibase.command.<cmdName>.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.	Optional

Attribute	Definition	Requirement
`JAVA_OPTS=-Dliquibase.command.changelogFile=<string>` `JAVA_OPTS=-Dliquibase.command.<cmdName>.changelogFile=<string>`	The root changelog	Required
`JAVA_OPTS=-Dliquibase.command.url=<string>` `JAVA_OPTS=-Dliquibase.command.<cmdName>.url=<string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase.	Required
`JAVA_OPTS=-Dliquibase.command.changeExecListenerClass=<string>` `JAVA_OPTS=-Dliquibase.command.<cmdName>.changeExecListenerClass=<string>`	Fully-qualified class which specifies a `ChangeExecListener`. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.	Optional
`JAVA_OPTS=-Dliquibase.command.changeExecListenerPropertiesFile=<string>` `JAVA_OPTS=-Dliquibase.command.<cmdName>.changeExecListenerPropertiesFile=<string>`	Path to a properties file for the `ChangeExecListener` class. For more information, see Implementing a Custom ChangeExecListener Class with Liquibase and ChangeExecListenerCommandStep.	Optional
`JAVA_OPTS=-Dliquibase.command.contextFilter=<string>` `JAVA_OPTS=-Dliquibase.command.<cmdName>.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`.	Optional
`JAVA_OPTS=-Dliquibase.command.defaultCatalogName=<string>` `JAVA_OPTS=-Dliquibase.command.<cmdName>.defaultCatalogName=<string>`	Name of the default catalog to use for the database connection	Optional
`JAVA_OPTS=-Dliquibase.command.defaultSchemaName=<string>` `JAVA_OPTS=-Dliquibase.command.<cmdName>.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`. Tip: In Liquibase v4.23.0+, camelCase for `defaultSchemaName` works successfully. If you are on an earlier version, camelCase may not work as expected. Note: The syntax `liquibase.command.defaultSchemaName` is valid for v4.19.0+. For prior versions, use `defaultSchemaName`.	Optional
`JAVA_OPTS=-Dliquibase.command.driver=<string>` `JAVA_OPTS=-Dliquibase.command.<cmdName>.driver=<string>`	The JDBC driver class	Optional
`JAVA_OPTS=-Dliquibase.command.driverPropertiesFile=<string>` `JAVA_OPTS=-Dliquibase.command.<cmdName>.driverPropertiesFile=<string>`	The JDBC driver properties file	Optional
`JAVA_OPTS=-Dliquibase.command.forceOnPartialChanges=<true\|false>` `JAVA_OPTS=-Dliquibase.command.<cmdName>.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`.	Optional
`JAVA_OPTS=-Dliquibase.command.labelFilter=<string>` `JAVA_OPTS=-Dliquibase.command.<cmdName>.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.	Optional
`JAVA_OPTS=-Dliquibase.command.password=<string>` `JAVA_OPTS=-Dliquibase.command.<cmdName>.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.	Optional
`JAVA_OPTS=-Dliquibase.command.rollbackOnError=<true\|false>` `JAVA_OPTS=-Dliquibase.command.<cmdName>.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`.	Optional
`JAVA_OPTS=-Dliquibase.command.username=<string>` `JAVA_OPTS=-Dliquibase.command.<cmdName>.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.	Optional

Attribute	Definition	Requirement
`LIQUIBASE_COMMAND_CHANGELOG_FILE=<string>` `LIQUIBASE_COMMAND_<CMDNAME>_CHANGELOG_FILE=<string>`	The root changelog	Required
`LIQUIBASE_COMMAND_URL=<string>` `LIQUIBASE_COMMAND_<CMDNAME>_URL=<string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase.	Required
`LIQUIBASE_COMMAND_CHANGE_EXEC_LISTENER_CLASS=<string>` `LIQUIBASE_COMMAND_<CMDNAME>_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.	Optional
`LIQUIBASE_COMMAND_CHANGE_EXEC_LISTENER_PROPERTIES_FILE=<string>` `LIQUIBASE_COMMAND_<CMDNAME>_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.	Optional
`LIQUIBASE_COMMAND_CONTEXT_FILTER=<string>` `LIQUIBASE_COMMAND_<CMDNAME>_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`.	Optional
`LIQUIBASE_COMMAND_DEFAULT_CATALOG_NAME=<string>` `LIQUIBASE_COMMAND_<CMDNAME>_DEFAULT_CATALOG_NAME=<string>`	Name of the default catalog to use for the database connection	Optional
`LIQUIBASE_COMMAND_DEFAULT_SCHEMA_NAME=<string>` `LIQUIBASE_COMMAND_<CMDNAME>_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`. Tip: In Liquibase v4.23.0+, camelCase for `defaultSchemaName` works successfully. If you are on an earlier version, camelCase may not work as expected. Note: The syntax `liquibase.command.defaultSchemaName` is valid for v4.19.0+. For prior versions, use `defaultSchemaName`.	Optional
`LIQUIBASE_COMMAND_DRIVER=<string>` `LIQUIBASE_COMMAND_<CMDNAME>_DRIVER=<string>`	The JDBC driver class	Optional
`LIQUIBASE_COMMAND_DRIVER_PROPERTIES_FILE=<string>` `LIQUIBASE_COMMAND_<CMDNAME>_DRIVER_PROPERTIES_FILE=<string>`	The JDBC driver properties file	Optional
`LIQUIBASE_COMMAND_FORCE_ON_PARTIAL_CHANGES=<true\|false>` `LIQUIBASE_COMMAND_<CMDNAME>_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`.	Optional
`LIQUIBASE_COMMAND_LABEL_FILTER=<string>` `LIQUIBASE_COMMAND_<CMDNAME>_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.	Optional
`LIQUIBASE_COMMAND_PASSWORD=<string>` `LIQUIBASE_COMMAND_<CMDNAME>_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.	Optional
`LIQUIBASE_COMMAND_ROLLBACK_ON_ERROR=<true\|false>` `LIQUIBASE_COMMAND_<CMDNAME>_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`.	Optional
`LIQUIBASE_COMMAND_USERNAME=<string>` `LIQUIBASE_COMMAND_<CMDNAME>_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.	Optional

Note: The username and password attributes are not required for connections and systems which use alternate means of authentication. Also, you can specify database credentials as part of the url attribute.

Output

When successful, the update-testing-rollback command produces the following output:

Liquibase Version: 4.9.1
Liquibase Community 4.9.1 by Liquibase

Liquibase command 'update-testing-rollback' was executed successfully.