The rollback report is a Liquibaseoperation report that informs you of system, runtime, operation, and changeset information about your database rollbacks in a human-readable format.
JVM system property: JAVA_OPTS="-Dliquibase.report.enabled=true" liquibase rollback
Rollback reports in automation
To automatically use Liquibaserollback reports in your CI/CD pipeline, follow these steps in your CI/CD tool:
Create a LiquibaseRollbackReport job that generates the rollback report. This job must:
Enable the rollback report with --reports-enabled (global scope) or --report-enabled (command scope).
Run a Liquibaserollback* command against your database.
Tip: For more information, see the Examples section of this page.
Examples
Setting parameters
You can modify the rollback report output with the parameters listed in the tables on this page. In the CLI, global parameters go to the left of the command and command parameters go to the right of the command.
Note: For readability, this page shows parameters on new lines. If you type in the commands on a single line, do not include the backslashes \ shown in the examples.
Disable reports by default; enable only the rollback report
If you want to keep reports disabled by default and enable only the rollback report, you can use the command parameter --report-enabled (singular) on a rollback family command. For example:
Note: This example uses reports-enabled (plural) within globalArgs to enables all operation reports. To enable this specific kind of report, but not other reports, you must instead set report-enabled (singular) in cmdArgs.
Use these parameters to control the behavior of all operation reports.
Parameter
Type
Description
Requirement
--reports-enabled=<true|false>
Boolean
Enables or disables all reports at the global level. Overridden by --report-enabled at the command level. Default: false.
Required (either this or --report-enabled)
--reports-name=<string>
String
Specifies the name of the report file at the global level. Overridden by --report-name at the command level. 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
--reports-open=<true|false>
Boolean
Specifies whether to automatically open the report in your default browser at the global level. Overridden by --report-open at the command level. Default: true.
Optional
--reports-path=<string>
String
Specifies the file path to the report file at the global level. Overridden by --report-path at the command level. Default: ./
Optional
Command parameters
Use these command parameters if you want to specify operation report behavior for a specific command.
Parameter
Type
Description
Requirement
--report-enabled=<true|false>
Boolean
Enables a report at the command level. Overrides the global argument --reports-enabled. Default: false.
Required (either this or --reports-enabled)
--report-name=<string>
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-open=<true|false>
Boolean
If true, automatically opens the report in your default browser. Default: false.
Note: Prior to Liquibase 4.29.0, this parameter was called --open-report instead of --report-open.
Optional
--report-path=<string>
String
Specifies the file path to the report file at the command level. Overrides the global argument --reports-path. Default: ./.
Optional
Global parameters
Use these parameters to control the behavior of all operation reports.
Parameter
Type
Description
Requirement
globalArgs: { reports-enabled: "<true|false>" }
Boolean
Enables or disables all reports at the global level. Overridden by --report-enabled at the command level. Default: false.
Required (either this or --report-enabled)
globalArgs: { reports-name: "<string>" }
String
Specifies the name of the report file at the global level. Overridden by --report-name at the command level. 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
globalArgs: { reports-open: "<true|false>" }
Boolean
Specifies whether to automatically open the report in your default browser at the global level. Overridden by --report-open at the command level. Default: true.
Optional
globalArgs: { reports-path: "<string>" }
String
Specifies the file path to the report file at the global level. Overridden by --report-path at the command level. Default: ./
Optional
Command parameters
Use these command parameters if you want to specify operation report behavior for a specific command.
Parameter
Type
Description
Requirement
cmdArgs: { report-enabled: "<true|false>" }
Boolean
Enables a report at the command level. Overrides the global argument --reports-enabled. Default: false.
Required (either this or --reports-enabled)
cmdArgs: { report-name: "<string>" }
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-open: "<true|false>" }
Boolean
If true, automatically opens the report in your default browser. Default: false.
Note: Prior to Liquibase 4.29.0, this parameter was called --open-report instead of --report-open.
Optional
cmdArgs: { report-path: "<string>" }
String
Specifies the file path to the report file at the command level. Overrides the global argument --reports-path. Default: ./.
Optional
Global parameters
Use these parameters to control the behavior of all operation reports.
Parameter
Type
Description
Requirement
liquibase.reports.enabled: <true|false>
Boolean
Enables or disables all reports at the global level. Overridden by --report-enabled at the command level. Default: false.
Required (either this or --report-enabled)
liquibase.reports.name: <string>
String
Specifies the name of the report file at the global level. Overridden by --report-name at the command level. 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.reports.open: <true|false>
Boolean
Specifies whether to automatically open the report in your default browser at the global level. Overridden by --report-open at the command level. Default: true.
Optional
liquibase.reports.path: <string>
String
Specifies the file path to the report file at the global level. Overridden by --report-path at the command level. Default: ./
Optional
Command parameters
Use these command parameters if you want to specify operation report behavior for a specific command.
Enables a report at the command level. Overrides the global argument --reports-enabled. Default: false.
Required (either this or --reports-enabled)
liquibase.command.reportName: <string>
liquibase.command.<cmdName>.reportName: <string>
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.
Enables or disables all reports at the global level. Overridden by --report-enabled at the command level. Default: false.
Required (either this or --report-enabled)
JAVA_OPTS=-Dliquibase.reports.name=<string>
String
Specifies the name of the report file at the global level. Overridden by --report-name at the command level. 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.reports.open=<true|false>
Boolean
Specifies whether to automatically open the report in your default browser at the global level. Overridden by --report-open at the command level. Default: true.
Optional
JAVA_OPTS=-Dliquibase.reports.path=<string>
String
Specifies the file path to the report file at the global level. Overridden by --report-path at the command level. Default: ./
Optional
Command parameters
Use these command parameters if you want to specify operation report behavior for a specific command.
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.
Specifies the file path to the report file at the command level. Overrides the global argument --reports-path. Default: ./.
Optional
Global parameters
Use these parameters to control the behavior of all operation reports.
Parameter
Type
Description
Requirement
LIQUIBASE_REPORTS_ENABLED=<true|false>
Boolean
Enables or disables all reports at the global level. Overridden by --report-enabled at the command level. Default: false.
Required (either this or --report-enabled)
LIQUIBASE_REPORTS_NAME=<string>
String
Specifies the name of the report file at the global level. Overridden by --report-name at the command level. 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_REPORTS_OPEN=<true|false>
Boolean
Specifies whether to automatically open the report in your default browser at the global level. Overridden by --report-open at the command level. Default: true.
Optional
LIQUIBASE_REPORTS_PATH=<string>
String
Specifies the file path to the report file at the global level. Overridden by --report-path at the command level. Default: ./
Optional
Command parameters
Use these command parameters if you want to specify operation report behavior for a specific command.
Enables a report at the command level. Overrides the global argument --reports-enabled. Default: false.
Required (either this or --reports-enabled)
LIQUIBASE_COMMAND_REPORT_NAME=<string>
LIQUIBASE_COMMAND_<CMD_NAME>_REPORT_NAME=<string>
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.