rollback-one-changeset

Note: This is a Liquibase Pro feature, so you need a Liquibase Pro License Key to use it.


The rollback-one-changeset command reverts (rolls back) one non-sequential changeset made during a previous change to your database. It is only available for Liquibase Pro users.

Uses

The rollback-one-changeset command is typically used when you want to undo a change made to your database and revert it to a previous state without affecting any other changes made to your database.

While the rollback command reverts all changesets deployed sequentially to a specified point by using rollbackDate, rollback-count, or rollback <tag_name>, the rollback-one-changeset command allows you to target a specific changeset without impacting changesets that came before or after it.

The image above shows changesets A through I, with changeset I being the most recently deployed. As you can see, the rollback-one-changeset command allows you to target changeset B and revert it to its previous state without impacting the others.

In Liquibase Pro 4.27.0 and later, you can automatically generate a database Rollback Report summarizing this command.

Impact

Like any targeted tool, using the rollback-one-changeset command comes with risks of unintended consequences. Because of this, the command requires a --force flag to indicate that you intend to run it.

Warning: Look for potential unintended consequences before using this command.

It is a best practice to run the rollback-one-changeset-sql command because it allows you to inspect the rollback SQL and search for any potential mistakes before you execute rollback-one-changeset.

Syntax

Before running the rollback-one-changeset command, gather the following information from your DATABASECHANGELOG table or by running the history command:

  • The author of the changeset you want to revert
  • The ID of the changeset you want to revert
  • The file path and name of the changeset you want to revert

Then run the rollback-one-changeset command, with your information:

liquibase rollback-one-changeset --changelog-file=example-changelog.xml --changeset-author="LiquibaseProUser" --changeset-id="createProc-proschema" --changeset-path=changelog.xml --force

For more command-specific help, type liquibase rollback-one-changeset --help into the command prompt.

Parameters

Global parameters

Attribute Definition Requirement

--license-key=<string>

Your Liquibase Pro license key

 Required

Command parameters

Attribute Definition Requirement

--changelog-file=<string>

The root changelog

 Required

--changeset-author=<string>

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

 Required

--changeset-id=<string>

The changeset ID from the changelog.

 Required

--changeset-path=<string>

The path to the changelog containing the changeset you want to roll back.

 Required

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

 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

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

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

--report-enabled=<true|false>

Enables a report at the command level. Overrides the global argument --reports-enabled. Default: false.

 Optional

--report-name=<string>

Specifies the name of the report file at the command level. Overrides the global argument --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.

 Optional

--report-path=<string>

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

 Optional

--rollback-script=<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.

 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

Global parameters

Attribute Definition Requirement

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

Your Liquibase Pro license key

 Required

Command parameters

Attribute Definition Requirement

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

The root changelog

 Required

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

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

 Required

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

The changeset ID from the changelog.

 Required

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

The path to the changelog containing the changeset you want to roll back.

 Required

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.

 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: { 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: { 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: { report-enabled: "<true|false>" }

Enables a report at the command level. Overrides the global argument --reports-enabled. Default: false.

 Optional

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

Specifies the name of the report file at the command level. Overrides the global argument --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.

 Optional

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

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

 Optional

cmdArgs: { rollback-script: "<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.

 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

Global parameters

Attribute Definition Requirement

liquibase.licenseKey: <string>

Your Liquibase Pro license key

 Required

Command parameters

Attribute Definition Requirement

liquibase.command.changelogFile: <string>

liquibase.command.rollbackOneChangeset.changelogFile: <string>

The root changelog

 Required

liquibase.command.changesetAuthor: <string>

liquibase.command.rollbackOneChangeset.changesetAuthor: <string>

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

 Required

liquibase.command.changesetId: <string>

liquibase.command.rollbackOneChangeset.changesetId: <string>

The changeset ID from the changelog.

 Required

liquibase.command.changesetPath: <string>

liquibase.command.rollbackOneChangeset.changesetPath: <string>

The path to the changelog containing the changeset you want to roll back.

 Required

liquibase.command.force: <true|false>

liquibase.command.rollbackOneChangeset.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.

 Required

liquibase.command.url: <string>

liquibase.command.rollbackOneChangeset.url: <string>

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

 Required

liquibase.command.changeExecListenerClass: <string>

liquibase.command.rollbackOneChangeset.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.rollbackOneChangeset.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.defaultCatalogName: <string>

liquibase.command.rollbackOneChangeset.defaultCatalogName: <string>

Name of the default catalog to use for the database connection

 Optional

liquibase.command.defaultSchemaName: <string>

liquibase.command.rollbackOneChangeset.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.rollbackOneChangeset.driver: <string>

The JDBC driver class

 Optional

liquibase.command.driverPropertiesFile: <string>

liquibase.command.rollbackOneChangeset.driverPropertiesFile: <string>

The JDBC driver properties file

 Optional

liquibase.command.password: <string>

liquibase.command.rollbackOneChangeset.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.reportEnabled: <true|false>

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

Enables a report at the command level. Overrides the global argument --reports-enabled. Default: false.

 Optional

liquibase.command.reportName: <string>

liquibase.command.rollbackOneChangeset.reportName: <string>

Specifies the name of the report file at the command level. Overrides the global argument --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.

 Optional

liquibase.command.reportPath: <string>

liquibase.command.rollbackOneChangeset.reportPath: <string>

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

 Optional

liquibase.command.rollbackScript: <string>

liquibase.command.rollbackOneChangeset.rollbackScript: <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.

 Optional *

liquibase.command.username: <string>

liquibase.command.rollbackOneChangeset.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

Global parameters

Attribute Definition Requirement

JAVA_OPTS=-Dliquibase.licenseKey=<string>

Your Liquibase Pro license key

 Required

Command parameters

Attribute Definition Requirement

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

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

The root changelog

 Required

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

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

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

 Required

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

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

The changeset ID from the changelog.

 Required

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

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

The path to the changelog containing the changeset you want to roll back.

 Required

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

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

 Required

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

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

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

 Required

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

JAVA_OPTS=-Dliquibase.command.rollbackOneChangeset.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.rollbackOneChangeset.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.defaultCatalogName=<string>

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

Name of the default catalog to use for the database connection

 Optional

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

JAVA_OPTS=-Dliquibase.command.rollbackOneChangeset.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.rollbackOneChangeset.driver=<string>

The JDBC driver class

 Optional

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

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

The JDBC driver properties file

 Optional

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

JAVA_OPTS=-Dliquibase.command.rollbackOneChangeset.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.reportEnabled=<true|false>

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

Enables a report at the command level. Overrides the global argument --reports-enabled. Default: false.

 Optional

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

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

Specifies the name of the report file at the command level. Overrides the global argument --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.

 Optional

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

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

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

 Optional

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

JAVA_OPTS=-Dliquibase.command.rollbackOneChangeset.rollbackScript=<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.

 Optional *

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

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

Global parameters

Attribute Definition Requirement

LIQUIBASE_LICENSE_KEY=<string>

Your Liquibase Pro license key

 Required

Command parameters

Attribute Definition Requirement

LIQUIBASE_COMMAND_CHANGELOG_FILE=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_CHANGELOG_FILE=<string>

The root changelog

 Required

LIQUIBASE_COMMAND_CHANGESET_AUTHOR=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_CHANGESET_AUTHOR=<string>

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

 Required

LIQUIBASE_COMMAND_CHANGESET_ID=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_CHANGESET_ID=<string>

The changeset ID from the changelog.

 Required

LIQUIBASE_COMMAND_CHANGESET_PATH=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_CHANGESET_PATH=<string>

The path to the changelog containing the changeset you want to roll back.

 Required

LIQUIBASE_COMMAND_FORCE=<true|false>

LIQUIBASE_COMMAND_ROLLBACK_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.

 Required

LIQUIBASE_COMMAND_URL=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_URL=<string>

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

 Required

LIQUIBASE_COMMAND_CHANGE_EXEC_LISTENER_CLASS=<string>

LIQUIBASE_COMMAND_ROLLBACK_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.

 Optional

LIQUIBASE_COMMAND_CHANGE_EXEC_LISTENER_PROPERTIES_FILE=<string>

LIQUIBASE_COMMAND_ROLLBACK_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.

 Optional

LIQUIBASE_COMMAND_DEFAULT_CATALOG_NAME=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_DEFAULT_CATALOG_NAME=<string>

Name of the default catalog to use for the database connection

 Optional

LIQUIBASE_COMMAND_DEFAULT_SCHEMA_NAME=<string>

LIQUIBASE_COMMAND_ROLLBACK_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.

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

The JDBC driver class

 Optional

LIQUIBASE_COMMAND_DRIVER_PROPERTIES_FILE=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_DRIVER_PROPERTIES_FILE=<string>

The JDBC driver properties file

 Optional

LIQUIBASE_COMMAND_PASSWORD=<string>

LIQUIBASE_COMMAND_ROLLBACK_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.

 Optional

LIQUIBASE_COMMAND_REPORT_ENABLED=<true|false>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_REPORT_ENABLED=<true|false>

Enables a report at the command level. Overrides the global argument --reports-enabled. Default: false.

 Optional

LIQUIBASE_COMMAND_REPORT_NAME=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_REPORT_NAME=<string>

Specifies the name of the report file at the command level. Overrides the global argument --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.

 Optional

LIQUIBASE_COMMAND_REPORT_PATH=<string>

LIQUIBASE_COMMAND_ROLLBACK_ONE_CHANGESET_REPORT_PATH=<string>

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

 Optional

LIQUIBASE_COMMAND_ROLLBACK_SCRIPT=<string>

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

 Optional *

LIQUIBASE_COMMAND_USERNAME=<string>

LIQUIBASE_COMMAND_ROLLBACK_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.

 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 rollback-one-changeset command produces the following output:

Liquibase Version: 4.9.1
Liquibase Pro 4.9.1 by Liquibase licensed to Liquibase Pro Evaluation until Tue Jun 07 18:00:00 MDT 2022
WARNING!  Your license will expire in 29 days!
To renew Liquibase Pro please contact sales@liquibase.com or go to https://www.liquibase.org/download
Rolling Back Changeset: example-changelog.sql::2::your.name

rollback-one-changeset executed for DBUSER@jdbc:h2:tcp://localhost:9090/mem:dev
Liquibase command 'rollback-one-changeset' was executed successfully.

Like what you see? Try this command in Pro for Free.

Related links