Rollback Report

The rollback report is a Liquibase operation report that informs you of system, runtime, operation, and changeset information about your database rollbacks in a human-readable format.

In Liquibase 4.27.0 and later, you can automatically generate a database rollback report using the Liquibase rollback family of commands: rollback, rollback-count, rollback-one-changeset, rollback-one-update, and rollback-to-date.

Uses

Using Liquibase rollback reports can help developers, DBAs, DevOps engineers, and managers in the following ways:

• Understand and share the data on the execution of rollback commands
• Easily scan and understand a high-level overview of the changesets rolled back
• Get a detailed view of both successful and failed rollbacks
• Collaborate with your team with shareable reports in PDF format

Enable operation reports

To enable all operation reports, you must:

1. Set the --license-key property using your Liquibase Pro license key.
2. Choose how often to generate reports. You can either:
   • Always generate reports:
     • liquibase.properties file: liquibase.reports.enabled=true
     • Environment variable: LIQUIBASE_REPORTS_ENABLED=true
     • Then, when you run liquibase rollback, Liquibase always generates a report
   • Selectively generate reports at runtime:
     • Command line: liquibase --reports-enabled=true rollback
     • JVM system property: JAVA_OPTS="-Dliquibase.reports.enabled=true" liquibase rollback

Rollback reports in automation

To automatically use Liquibase rollback reports in your CI/CD pipeline, follow these steps in your CI/CD tool:

1. Create a LiquibaseRollbackReport job that generates the rollback report. This job must:
   1. Enable the rollback report with --reports-enabled (global scope) or --report-enabled (command scope).
   2. Run a Liquibase rollback* 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.

liquibase \
    --reports-enabled=true \
    --reports-path=reports \
    --reports-name=rollback_report.html \
  rollback \
    --changelog-file="example-changelog.xml"

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.

You can also set parameters in your liquibase.properties file, as environment variables, or in a flow file. For a list of parameters and their syntax in each format, see the Global parameters and Command parameters sections of this page.

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:

liquibase rollback \
    --report-enabled=true \
    --report-name=my_rollback_report.html

stages:
  Rollback_Report:
    actions:
      - type: liquibase
        command: rollback
        cmdArgs: { changelog-file: "example-changelog.xml",
                        report-format: "HTML"}
        globalArgs: { mirror-console-messages-to-log: "true",
                        reports-enabled: "true",
                        reports-path: "reports",
                        reports-name: "rollback-report.html"}

Global parameters

Use these parameters to control the behavior of all operation reports.

Note: Syntax for each parameter is specified in kebab-case (CLI and flow file), camelCase (properties file and JAVA_OPTS), and MACRO_CASE (environment variable).

--reports-enabled
globalArgs: {reports-enabled: "val"}
liquibase.reports.enabled
LIQUIBASE_REPORTS_ENABLED

--reports-name
globalArgs: {reports-name: "val"}
liquibase.reports.name
LIQUIBASE_REPORTS_NAME

--reports-path
globalArgs: {reports-path: "val"}
liquibase.reports.path
LIQUIBASE_REPORTS_PATH

Command parameters

Use these command parameters if you want to specify operation report behavior for a specific command.

--report-enabled
cmdArgs: {report-enabled: "val"}
liquibase.command.<cmdName>.reportEnabled
LIQUIBASE_COMMAND_<CMDNAME>_REPORT_ENABLED

--open-report
cmdArgs: {open-report: "val"}
liquibase.command.<cmdName>.openReport
LIQUIBASE_COMMAND_<CMDNAME>_OPEN_REPORT

--report-name
cmdArgs: {report-name: "val"}
liquibase.command.<cmdName>.reportName
LIQUIBASE_COMMAND_<CMDNAME>_REPORT_NAME

--report-path
cmdArgs: {report-path: "val"}
liquibase.command.<cmdName>.reportPath
LIQUIBASE_COMMAND_<CMDNAME>_REPORT_PATH

Related videos

Learn more about Rollback Reports in Liquibase Pro