• Concept
  • Version · 6.0
  • Deliver

What parameters can I use with operation reports?

Last updated: September 29, 2026

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

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

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

Boolean

Liquibase Secure 6.0 and later. Specifies whether to hide the detail rows for skipped (filtered out) changesets in operation reports at the global level. The report still displays the total number of skipped changesets in its summary. Overridden by --report-suppress-skipped 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. Overrides the global parameter --reports-suppress-sql. Default: false.

Optional

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

Boolean

Liquibase Secure 6.0 and later. Specifies whether to hide the detail rows for skipped (filtered out) changesets in operation reports at the command level. The report still displays the total number of skipped changesets in its summary. Overrides the global parameter --reports-suppress-skipped. Default: false.

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

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

globalArgs: { 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

globalArgs: { 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

globalArgs: { reports-suppress-skipped: "<true|false>" }

Boolean

Liquibase Secure 6.0 and later. Specifies whether to hide the detail rows for skipped (filtered out) changesets in operation reports at the global level. The report still displays the total number of skipped changesets in its summary. Overridden by --report-suppress-skipped 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

cmdArgs: { 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)

cmdArgs: { 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

cmdArgs: { 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

cmdArgs: { 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

cmdArgs: { 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

cmdArgs: { 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

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

Optional

cmdArgs: { 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

cmdArgs: { report-suppress-sql: "<true|false>" }

Boolean

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

Optional

cmdArgs: { report-suppress-skipped: "<true|false>" }

Boolean

Liquibase Secure 6.0 and later. Specifies whether to hide the detail rows for skipped (filtered out) changesets in operation reports at the command level. The report still displays the total number of skipped changesets in its summary. Overrides the global parameter --reports-suppress-skipped. Default: false.

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

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

liquibase.reports.suppressException: <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

liquibase.reports.suppressSql: <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

liquibase.reports.suppressSkipped: <true|false>

Boolean

Liquibase Secure 6.0 and later. Specifies whether to hide the detail rows for skipped (filtered out) changesets in operation reports at the global level. The report still displays the total number of skipped changesets in its summary. Overridden by --report-suppress-skipped 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

liquibase.command.reportEnabled: <true|false>

liquibase.command.<cmdName>.reportEnabled: <true|false>

Boolean

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

Required (either this or --reports-enabled)

liquibase.command.driftSeverity: <string>

liquibase.command.<cmdName>.driftSeverity: <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

liquibase.command.driftSeverityChanged: <string>

liquibase.command.<cmdName>.driftSeverityChanged: <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

liquibase.command.driftSeverityMissing: <string>

liquibase.command.<cmdName>.driftSeverityMissing: <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

liquibase.command.driftSeverityUnexpected: <string>

liquibase.command.<cmdName>.driftSeverityUnexpected: <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

liquibase.command.reportName: <string>

liquibase.command.<cmdName>.reportName: <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

liquibase.command.reportOpen: <true|false>

liquibase.command.<cmdName>.reportOpen: <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

liquibase.command.reportPath: <string>

liquibase.command.<cmdName>.reportPath: <string>

String

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

Optional

liquibase.command.reportSuppressException: <true|false>

liquibase.command.<cmdName>.reportSuppressException: <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

liquibase.command.reportSuppressSql: <true|false>

liquibase.command.<cmdName>.reportSuppressSql: <true|false>

Boolean

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

Optional

liquibase.command.reportSuppressSkipped: <true|false>

liquibase.command.<cmdName>.reportSuppressSkipped: <true|false>

Boolean

Liquibase Secure 6.0 and later. Specifies whether to hide the detail rows for skipped (filtered out) changesets in operation reports at the command level. The report still displays the total number of skipped changesets in its summary. Overrides the global parameter --reports-suppress-skipped. Default: false.

Optional

Global parameters

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

Parameter

Type

Description

Requirement

JAVA_OPTS=-Dliquibase.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)

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

JAVA_OPTS=-Dliquibase.reports.suppressException=<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

JAVA_OPTS=-Dliquibase.reports.suppressSql=<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

JAVA_OPTS=-Dliquibase.reports.suppressSkipped=<true|false>

Boolean

Liquibase Secure 6.0 and later. Specifies whether to hide the detail rows for skipped (filtered out) changesets in operation reports at the global level. The report still displays the total number of skipped changesets in its summary. Overridden by --report-suppress-skipped 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

JAVA_OPTS=-Dliquibase.command.reportEnabled=<true|false>

JAVA_OPTS=-Dliquibase.command.<cmdName>.reportEnabled=<true|false>

Boolean

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

Required (either this or --reports-enabled)

JAVA_OPTS=-Dliquibase.command.driftSeverity=<string>

JAVA_OPTS=-Dliquibase.command.<cmdName>.driftSeverity=<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

JAVA_OPTS=-Dliquibase.command.driftSeverityChanged=<string>

JAVA_OPTS=-Dliquibase.command.<cmdName>.driftSeverityChanged=<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

JAVA_OPTS=-Dliquibase.command.driftSeverityMissing=<string>

JAVA_OPTS=-Dliquibase.command.<cmdName>.driftSeverityMissing=<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

JAVA_OPTS=-Dliquibase.command.driftSeverityUnexpected=<string>

JAVA_OPTS=-Dliquibase.command.<cmdName>.driftSeverityUnexpected=<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

JAVA_OPTS=-Dliquibase.command.reportName=<string>

JAVA_OPTS=-Dliquibase.command.<cmdName>.reportName=<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

JAVA_OPTS=-Dliquibase.command.reportOpen=<true|false>

JAVA_OPTS=-Dliquibase.command.<cmdName>.reportOpen=<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

JAVA_OPTS=-Dliquibase.command.reportPath=<string>

JAVA_OPTS=-Dliquibase.command.<cmdName>.reportPath=<string>

String

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

Optional

JAVA_OPTS=-Dliquibase.command.reportSuppressException=<true|false>

JAVA_OPTS=-Dliquibase.command.<cmdName>.reportSuppressException=<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

JAVA_OPTS=-Dliquibase.command.reportSuppressSql=<true|false>

JAVA_OPTS=-Dliquibase.command.<cmdName>.reportSuppressSql=<true|false>

Boolean

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

Optional

JAVA_OPTS=-Dliquibase.command.reportSuppressSkipped=<true|false>

JAVA_OPTS=-Dliquibase.command.<cmdName>.reportSuppressSkipped=<true|false>

Boolean

Liquibase Secure 6.0 and later. Specifies whether to hide the detail rows for skipped (filtered out) changesets in operation reports at the command level. The report still displays the total number of skipped changesets in its summary. Overrides the global parameter --reports-suppress-skipped. Default: false.

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

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

LIQUIBASE_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

LIQUIBASE_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

LIQUIBASE_REPORTS_SUPPRESS_SKIPPED=<true|false>

Boolean

Liquibase Secure 6.0 and later. Specifies whether to hide the detail rows for skipped (filtered out) changesets in operation reports at the global level. The report still displays the total number of skipped changesets in its summary. Overridden by --report-suppress-skipped 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

LIQUIBASE_COMMAND_REPORT_ENABLED=<true|false>

LIQUIBASE_COMMAND_<CMD_NAME>_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)

LIQUIBASE_COMMAND_DRIFT_SEVERITY=<string>

LIQUIBASE_COMMAND_<CMD_NAME>_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

LIQUIBASE_COMMAND_DRIFT_SEVERITY_CHANGED=<string>

LIQUIBASE_COMMAND_<CMD_NAME>_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

LIQUIBASE_COMMAND_DRIFT_SEVERITY_MISSING=<string>

LIQUIBASE_COMMAND_<CMD_NAME>_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

LIQUIBASE_COMMAND_DRIFT_SEVERITY_UNEXPECTED=<string>

LIQUIBASE_COMMAND_<CMD_NAME>_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

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

LIQUIBASE_COMMAND_REPORT_OPEN=<true|false>

LIQUIBASE_COMMAND_<CMD_NAME>_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

LIQUIBASE_COMMAND_REPORT_PATH=<string>

LIQUIBASE_COMMAND_<CMD_NAME>_REPORT_PATH=<string>

String

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

Optional

LIQUIBASE_COMMAND_REPORT_SUPPRESS_EXCEPTION=<true|false>

LIQUIBASE_COMMAND_<CMD_NAME>_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

LIQUIBASE_COMMAND_REPORT_SUPPRESS_SQL=<true|false>

LIQUIBASE_COMMAND_<CMD_NAME>_REPORT_SUPPRESS_SQL=<true|false>

Boolean

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

Optional

LIQUIBASE_COMMAND_REPORT_SUPPRESS_SKIPPED=<true|false>

LIQUIBASE_COMMAND_<CMD_NAME>_REPORT_SUPPRESS_SKIPPED=<true|false>

Boolean

Liquibase Secure 6.0 and later. Specifies whether to hide the detail rows for skipped (filtered out) changesets in operation reports at the command level. The report still displays the total number of skipped changesets in its summary. Overrides the global parameter --reports-suppress-skipped. Default: false.

Optional

PreviousWhat is the Drift report?NextWhat is Liquibase observability?