`rollback-to-date`

The rollback-to-date command reverts your database to the state it was in at the date and time you specify.

Uses

The rollback-to-date command is mainly used when you want to revert all changes made to your database from today's date to the date and time you specify. The rollback-to-date command reverts those changesets to their previous state and allows you to target the date and time without impacting changes or deployments that came before the date and time you specified.

The image below shows four deployments performed at a different times: March, April, May, and February. Let's imagine that your current month is May and you want to roll back your database to March.

As you can see, the rollback-to-date command allows you to target deployment 2 performed on March 07, 2020 10:15 AM and revert all changes associated with deployments 4 through 2, to March without impacting the previous deployments—deployment 2 and 1.

Note: There are several ways to revert your changes with the rollback-to-date command. You can use YYYY-MM-DD HH:MM:SS or YYYY-MM-DD'T'HH:MM:SS formats to specify both date and time. Also, you can specify date or time only.

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

Impact

The use of rollback-to-date comes with risk of removing all changes from today's date to the date you specified. Also, there is an additional impact to the DATABASECHANGELOG table. When any change is rolled back, the row associated with that change is deleted from the DATABASECHANGELOG table. For this reason, look for unintended consequences before using this command.

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

Syntax

Before running the rollback-to-date command, run the history command to see the dates of all your previous changes.

To run the rollback-to-date 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 properties in your command line.

Then run the rollback-to-date command:

liquibase rollback-to-date --date=2020-05-07 --changelog-file=example-changelog.xml

Command parameters

Attribute	Definition	Requirement
`--changelog-file=<string>`	The root changelog	Required
`--date=<string>`	The date and time your database rolls back to. The date format is `YYYY-MM-DD HH:MM:SS` or `YYYY-MM-DD'T'HH:MM:SS`. However, it is possible to indicate the date or time only. Specify as `--date=myDate`. Positional format `<command> <date>` 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`. 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
`--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 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

Attribute	Definition	Requirement
`cmdArgs: { changelog-file: "<string>" }`	The root changelog	Required
`cmdArgs: { date: "<string>" }`	The date and time your database rolls back to. The date format is `YYYY-MM-DD HH:MM:SS` or `YYYY-MM-DD'T'HH:MM:SS`. However, it is possible to indicate the date or time only. Specify as `--date=myDate`. Positional format `<command> <date>` deprecated in 4.4+.	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: { 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: { 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

Attribute	Definition	Requirement
`liquibase.command.changelogFile: <string>` `liquibase.command.rollbackToDate.changelogFile: <string>`	The root changelog	Required
`liquibase.command.date: <string>` `liquibase.command.rollbackToDate.date: <string>`	The date and time your database rolls back to. The date format is `YYYY-MM-DD HH:MM:SS` or `YYYY-MM-DD'T'HH:MM:SS`. However, it is possible to indicate the date or time only. Specify as `--date=myDate`. Positional format `<command> <date>` deprecated in 4.4+.	Required
`liquibase.command.url: <string>` `liquibase.command.rollbackToDate.url: <string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase.	Required
`liquibase.command.changeExecListenerClass: <string>` `liquibase.command.rollbackToDate.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.rollbackToDate.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.rollbackToDate.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.rollbackToDate.defaultCatalogName: <string>`	Name of the default catalog to use for the database connection	Optional
`liquibase.command.defaultSchemaName: <string>` `liquibase.command.rollbackToDate.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.rollbackToDate.driver: <string>`	The JDBC driver class	Optional
`liquibase.command.driverPropertiesFile: <string>` `liquibase.command.rollbackToDate.driverPropertiesFile: <string>`	The JDBC driver properties file	Optional
`liquibase.command.labelFilter: <string>` `liquibase.command.rollbackToDate.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.rollbackToDate.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.rollbackToDate.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.rollbackToDate.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.rollbackToDate.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.rollbackToDate.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.rollbackToDate.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.rollbackToDate.changelogFile=<string>`	The root changelog	Required
`JAVA_OPTS=-Dliquibase.command.date=<string>` `JAVA_OPTS=-Dliquibase.command.rollbackToDate.date=<string>`	The date and time your database rolls back to. The date format is `YYYY-MM-DD HH:MM:SS` or `YYYY-MM-DD'T'HH:MM:SS`. However, it is possible to indicate the date or time only. Specify as `--date=myDate`. Positional format `<command> <date>` deprecated in 4.4+.	Required
`JAVA_OPTS=-Dliquibase.command.url=<string>` `JAVA_OPTS=-Dliquibase.command.rollbackToDate.url=<string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase.	Required
`JAVA_OPTS=-Dliquibase.command.changeExecListenerClass=<string>` `JAVA_OPTS=-Dliquibase.command.rollbackToDate.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.rollbackToDate.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.rollbackToDate.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.rollbackToDate.defaultCatalogName=<string>`	Name of the default catalog to use for the database connection	Optional
`JAVA_OPTS=-Dliquibase.command.defaultSchemaName=<string>` `JAVA_OPTS=-Dliquibase.command.rollbackToDate.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.rollbackToDate.driver=<string>`	The JDBC driver class	Optional
`JAVA_OPTS=-Dliquibase.command.driverPropertiesFile=<string>` `JAVA_OPTS=-Dliquibase.command.rollbackToDate.driverPropertiesFile=<string>`	The JDBC driver properties file	Optional
`JAVA_OPTS=-Dliquibase.command.labelFilter=<string>` `JAVA_OPTS=-Dliquibase.command.rollbackToDate.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.rollbackToDate.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.rollbackToDate.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.rollbackToDate.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.rollbackToDate.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.rollbackToDate.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.rollbackToDate.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_ROLLBACK_TO_DATE_CHANGELOG_FILE=<string>`	The root changelog	Required
`LIQUIBASE_COMMAND_DATE=<string>` `LIQUIBASE_COMMAND_ROLLBACK_TO_DATE_DATE=<string>`	The date and time your database rolls back to. The date format is `YYYY-MM-DD HH:MM:SS` or `YYYY-MM-DD'T'HH:MM:SS`. However, it is possible to indicate the date or time only. Specify as `--date=myDate`. Positional format `<command> <date>` deprecated in 4.4+.	Required
`LIQUIBASE_COMMAND_URL=<string>` `LIQUIBASE_COMMAND_ROLLBACK_TO_DATE_URL=<string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase.	Required
`LIQUIBASE_COMMAND_CHANGE_EXEC_LISTENER_CLASS=<string>` `LIQUIBASE_COMMAND_ROLLBACK_TO_DATE_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_TO_DATE_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_ROLLBACK_TO_DATE_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_ROLLBACK_TO_DATE_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_TO_DATE_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_TO_DATE_DRIVER=<string>`	The JDBC driver class	Optional
`LIQUIBASE_COMMAND_DRIVER_PROPERTIES_FILE=<string>` `LIQUIBASE_COMMAND_ROLLBACK_TO_DATE_DRIVER_PROPERTIES_FILE=<string>`	The JDBC driver properties file	Optional
`LIQUIBASE_COMMAND_LABEL_FILTER=<string>` `LIQUIBASE_COMMAND_ROLLBACK_TO_DATE_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_ROLLBACK_TO_DATE_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_TO_DATE_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_TO_DATE_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_TO_DATE_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_TO_DATE_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_TO_DATE_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.

Output

Liquibase Community 4.9.1 by Liquibase
Liquibase command 'rollback-to-date' was executed successfully.