What parameters can I use with operation reports?

Last updated: July 14, 2025

The following parameters can be used with all operation reports. This includes the checks, drift, update, and rollback reports.

Parameters

Global parameters

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

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

--reports-suppress-exception=<true|false>

Boolean

Liquibase 4.31.0+. Specifies whether to hide exceptions (which may contain SQL) from operation reports at the global level. Overridden by --report-suppress-exception at the command level. Default: false. However:

If --reports-suppress-exception is not set and --reports-suppress-sql=true, Liquibase suppresses all SQL, including exception SQL.

If --reports-suppress-exception=false and --reports-suppress-sql=true, Liquibase suppresses most SQL but shows exception SQL.

Optional

--reports-suppress-sql=<true|false>

Boolean

Liquibase 4.31.0+. Specifies whether to hide changeset SQL in operation reports at the global level. Overridden by --report-suppress-sql at the command level. Default: false.

Optional

Command parameters

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

When Liquibase detects database drift, it records that in your drift report. Use the --drift-severity parameter to specify a severity return code (severity level) for all kinds of drift: changed, missing, or unexpected content. The severity return code you set tells Liquibase how to react when it detects drift. You can use the severity return code as an alert for the rest of your CI/CD pipeline.

  • BLOCKER(4): drift is a blocker (most severe)

  • CRITICAL(3): drift is a critical error

  • MAJOR(2): drift is a major failure

  • MINOR (1): drift is a minor failure

  • INFO(0): drift is treated as an informational message (least severe)

If you want Liquibase to react to changed, missing, or unexpected content in different ways, you can set the individual --drift-severity-* parameters to specify a severity return code for each particular kind of drift. These parameters take priority over --drift-severity.

Parameter

Type

Description

Requirement

--report-enabled=<true|false>

Boolean

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

Required (either this or --reports-enabled)

--drift-severity=<string>

String

Specifies the severity level of all error types in the drift report (changed, missing, or unexpected content). Valid values are INFO (0), MINOR (1), MAJOR (2), CRITICAL (3), and BLOCKER (4), from least severe to most severe. If both --drift-severity and one of the individual error type arguments are set, the individual error type arguments take priority. Default: INFO.

Optional

--drift-severity-changed=<string>

String

Specifies the severity level of changed content in the drift report. Valid values are INFO (0), MINOR (1), MAJOR (2), CRITICAL (3), and BLOCKER (4), from least severe to most severe. Overrides the value of --drift-severity for changed content only. Default: INFO.

Optional

--drift-severity-missing=<string>

String

Specifies the severity level of missing content in the drift report. Valid values are INFO (0), MINOR (1), MAJOR (2), CRITICAL (3), and BLOCKER (4), from least severe to most severe. Overrides the value of --drift-severity for missing content only. Default: INFO.

Optional

--drift-severity-unexpected=<string>

String

Specifies the severity level of unexpected content in the drift report. Valid values are INFO (0), MINOR (1), MAJOR (2), CRITICAL (3), and BLOCKER (4), from least severe to most severe. Overrides the value of --drift-severity for unexpected content only. Default: INFO.

Optional

--report-name=<string>

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-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 parameter --reports-path. Default: ./.

Optional

--report-suppress-exception=<true|false>

Boolean

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>

Boolean

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