show

Note: This is a Liquibase Pro feature, so you need a Liquibase Pro License Key to use it.

The show subcommand prints the available checks and their configurations as indicated in the checks settings file to STDOUT.

Uses

You can use the show command to see the list of all available checks and inspect the dynamic checks.

Syntax

Run the command specifying your values:

liquibase checks show

Note: If you have a checks settings file customized for a specific environment or project, you need to pass that using the --checks-settings-file parameter. If you do not include this parameter, Liquibase uses the default settings file: liquibase.checks-settings.conf. See Use the Checks Settings Configuration File.

The command output will present your checks and their details.

Parameters

Global parameters

Parameter Definition Requirement

--license-key=<string>

Your Liquibase Pro license key

Required

Command parameters

Parameter Description Requirement

--auto-enable-new-checks=<true|false>

Automatically enable new quality checks in liquibase.checks.conf file when they are available. Default: false.

Optional

--auto-update=<string>

Allows automatic backup and updating of the liquibase.checks-settings.conf file when new quality checks are available. Valid values are ON and OFF. Default: OFF.

Optional

--check-name=<string>

The name of the check(s) you want to target. Comma-separated list of one or more enabled checks. Checks to exclude can be prefixed with the ! character. If no checks are specified, all enabled checks are targeted. For example: --check-name=shortname1,shortname2,!shortname3

Optional

--check-status=<string>

Only show the checks that are in the specified status. Valid values are ENABLED, DISABLED, and ALL. Default: ALL

Optional

--checks-packages=<string>

If using a checks packages file, optionally specify which packages should be run from the file as a comma-separated list.

Optional

--checks-settings-file=<string>

Specifies the checks settings file to use with commands. Write the relative path of the settings file that you want to read from or modify. For more information, see Use the Checks Settings Configuration File.

Optional

--show-cols=<string>

Only show the specified columns. Column options: id, checkname, type, priority, shortname, scope, enabled, severity, customization, description, and all. Specify multiple columns in a comma-separated list. Specify all to select all the columns. Default: shortname,scope,enabled,severity,customization,description

Optional

Global parameters

Parameter Definition Requirement

globalArgs: { license-key: "<string>" }

Your Liquibase Pro license key

Required

Command parameters

Parameter Description Requirement

cmdArgs: { auto-enable-new-checks: "<true|false>" }

Automatically enable new quality checks in liquibase.checks.conf file when they are available. Default: false.

Optional

cmdArgs: { auto-update: "<string>" }

Allows automatic backup and updating of the liquibase.checks-settings.conf file when new quality checks are available. Valid values are ON and OFF. Default: OFF.

Optional

cmdArgs: { check-name: "<string>" }

The name of the check(s) you want to target. Comma-separated list of one or more enabled checks. Checks to exclude can be prefixed with the ! character. If no checks are specified, all enabled checks are targeted. For example: --check-name=shortname1,shortname2,!shortname3

Optional

cmdArgs: { check-status: "<string>" }

Only show the checks that are in the specified status. Valid values are ENABLED, DISABLED, and ALL. Default: ALL

Optional

cmdArgs: { checks-packages: "<string>" }

If using a checks packages file, optionally specify which packages should be run from the file as a comma-separated list.

Optional

cmdArgs: { checks-settings-file: "<string>" }

Specifies the checks settings file to use with commands. Write the relative path of the settings file that you want to read from or modify. For more information, see Use the Checks Settings Configuration File.

Optional

cmdArgs: { show-cols: "<string>" }

Only show the specified columns. Column options: id, checkname, type, priority, shortname, scope, enabled, severity, customization, description, and all. Specify multiple columns in a comma-separated list. Specify all to select all the columns. Default: shortname,scope,enabled,severity,customization,description

Optional

Global parameters

Parameter Definition Requirement

liquibase.licenseKey: <string>

Your Liquibase Pro license key

Required

Command parameters

Parameter Description Requirement

liquibase.command.autoEnableNewChecks: <true|false>

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

Automatically enable new quality checks in liquibase.checks.conf file when they are available. Default: false.

Optional

liquibase.command.autoUpdate: <string>

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

Allows automatic backup and updating of the liquibase.checks-settings.conf file when new quality checks are available. Valid values are ON and OFF. Default: OFF.

Optional

liquibase.command.checkName: <string>

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

The name of the check(s) you want to target. Comma-separated list of one or more enabled checks. Checks to exclude can be prefixed with the ! character. If no checks are specified, all enabled checks are targeted. For example: --check-name=shortname1,shortname2,!shortname3

Optional

liquibase.command.checkStatus: <string>

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

Only show the checks that are in the specified status. Valid values are ENABLED, DISABLED, and ALL. Default: ALL

Optional

liquibase.command.checksPackages: <string>

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

If using a checks packages file, optionally specify which packages should be run from the file as a comma-separated list.

Optional

liquibase.command.checksSettingsFile: <string>

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

Specifies the checks settings file to use with commands. Write the relative path of the settings file that you want to read from or modify. For more information, see Use the Checks Settings Configuration File.

Optional

liquibase.command.showCols: <string>

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

Only show the specified columns. Column options: id, checkname, type, priority, shortname, scope, enabled, severity, customization, description, and all. Specify multiple columns in a comma-separated list. Specify all to select all the columns. Default: shortname,scope,enabled,severity,customization,description

Optional

Global parameters

Parameter Definition Requirement

JAVA_OPTS=-Dliquibase.licenseKey=<string>

Your Liquibase Pro license key

Required

Command parameters

Parameter Description Requirement

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

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

Automatically enable new quality checks in liquibase.checks.conf file when they are available. Default: false.

Optional

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

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

Allows automatic backup and updating of the liquibase.checks-settings.conf file when new quality checks are available. Valid values are ON and OFF. Default: OFF.

Optional

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

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

The name of the check(s) you want to target. Comma-separated list of one or more enabled checks. Checks to exclude can be prefixed with the ! character. If no checks are specified, all enabled checks are targeted. For example: --check-name=shortname1,shortname2,!shortname3

Optional

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

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

Only show the checks that are in the specified status. Valid values are ENABLED, DISABLED, and ALL. Default: ALL

Optional

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

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

If using a checks packages file, optionally specify which packages should be run from the file as a comma-separated list.

Optional

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

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

Specifies the checks settings file to use with commands. Write the relative path of the settings file that you want to read from or modify. For more information, see Use the Checks Settings Configuration File.

Optional

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

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

Only show the specified columns. Column options: id, checkname, type, priority, shortname, scope, enabled, severity, customization, description, and all. Specify multiple columns in a comma-separated list. Specify all to select all the columns. Default: shortname,scope,enabled,severity,customization,description

Optional

Global parameters

Parameter Definition Requirement

LIQUIBASE_LICENSE_KEY=<string>

Your Liquibase Pro license key

Required

Command parameters

Parameter Description Requirement

LIQUIBASE_COMMAND_AUTO_ENABLE_NEW_CHECKS=<true|false>

LIQUIBASE_COMMAND_<CMDNAME>_AUTO_ENABLE_NEW_CHECKS=<true|false>

Automatically enable new quality checks in liquibase.checks.conf file when they are available. Default: false.

Optional

LIQUIBASE_COMMAND_AUTO_UPDATE=<string>

LIQUIBASE_COMMAND_<CMDNAME>_AUTO_UPDATE=<string>

Allows automatic backup and updating of the liquibase.checks-settings.conf file when new quality checks are available. Valid values are ON and OFF. Default: OFF.

Optional

LIQUIBASE_COMMAND_CHECK_NAME=<string>

LIQUIBASE_COMMAND_<CMDNAME>_CHECK_NAME=<string>

The name of the check(s) you want to target. Comma-separated list of one or more enabled checks. Checks to exclude can be prefixed with the ! character. If no checks are specified, all enabled checks are targeted. For example: --check-name=shortname1,shortname2,!shortname3

Optional

LIQUIBASE_COMMAND_CHECK_STATUS=<string>

LIQUIBASE_COMMAND_<CMDNAME>_CHECK_STATUS=<string>

Only show the checks that are in the specified status. Valid values are ENABLED, DISABLED, and ALL. Default: ALL

Optional

LIQUIBASE_COMMAND_CHECKS_PACKAGES=<string>

LIQUIBASE_COMMAND_<CMDNAME>_CHECKS_PACKAGES=<string>

If using a checks packages file, optionally specify which packages should be run from the file as a comma-separated list.

Optional

LIQUIBASE_COMMAND_CHECKS_SETTINGS_FILE=<string>

LIQUIBASE_COMMAND_<CMDNAME>_CHECKS_SETTINGS_FILE=<string>

Specifies the checks settings file to use with commands. Write the relative path of the settings file that you want to read from or modify. For more information, see Use the Checks Settings Configuration File.

Optional

LIQUIBASE_COMMAND_SHOW_COLS=<string>

LIQUIBASE_COMMAND_<CMDNAME>_SHOW_COLS=<string>

Only show the specified columns. Column options: id, checkname, type, priority, shortname, scope, enabled, severity, customization, description, and all. Specify multiple columns in a comma-separated list. Specify all to select all the columns. Default: shortname,scope,enabled,severity,customization,description

Optional

Related links