rollback-count

The rollback-count command sequentially reverts a specified number of changesets on your database.

Uses

Use the rollback-count command when you want to roll back changes sequentially, starting with the most recent changes and working backward until the count you specify is reached.

The image below shows three changesets: a, b, and c. Running the command rollback-count --count=3 rolls back the last three changesets.

If you want to revert changeset a without having to roll back changeset b and changeset c as well, you can do it with the help of the rollback-one-changeset command.

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

Impact

Using rollback-count comes with the risk of removing all changes depending on the number you specify. Also, when you roll back any change, the row associated with that change is deleted from the DATABASECHANGELOG table.

Warning: rollback-count increments based on changesets in the changelog, not records in the DATABASECHANGELOG table. If you manually delete changesets from your changelog, rollback-count does not restore those changes. For best practices on maintaining large changelogs, see Trimming changelog files.

Look for unintended consequences before using this command.

The best practice is to run the rollback-count-sql command helper command because it allows you to inspect the rollback-count SQL and search for any potential mistakes before you execute the rollback-count command.

Syntax

Before running the rollback-count command, you can run the history command to see all your previously executed changes.

Note: rollback-count works from the bottom of the list toward the top.

To run the rollback-count 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 these in your command line.

Then run the rollback-count command:

liquibase rollback-count --count=2 --changelog-file=example-changelog.xml

Note: The --count=myCount syntax was added in Liquibase 4.4. If you use an older version, specify your count as a positional argument: <command> myCount.

Command parameters

Attribute Definition Requirement

--changelog-file=<string>

The root changelog

 Required

--count=<int>

Integer specifying how many changes Liquibase applies the command to. Specify as --count=myCount. Positional format <command> <count> deprecated in 4.4+.

 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.

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.

 Optional

--driver=<string>

The JDBC driver class

 Optional

--driver-properties-file=<string>

The JDBC driver properties file

 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

--report-enabled=<true|false>

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

 Optional

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

 Optional

--report-path=<string>

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

 Optional

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

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

 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

* Liquibase will check nested changelogs for definitions of the changesets to rollback

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.