show

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

Uses

You can typically use the show command to see the list of all available checks and inspect the dynamic checks you can copy, customize, delete, or reset.

Running the show command

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.

The command output will present your checks and their details.

Attributes

Tip: For best results, specify all commands and parameters with the --kebab-case format in the CLI. If your preference is camelCase, it will still work in the CLI.

Name Syntax Description
checks-settings-file

CLI: --checks-settings-file

Property: liquibase.command.checks.show.checksSettingsFile

Environment Variable: LIQUIBASE_COMMAND_CHECKS_SHOW_CHECKS_SETTINGS_FILE

Specifies the checks settings file to use with subcommands.

Write the relative path of the settings file that you want to read from or modify.

For more information, see Using the Checks Settings Configuration File .

auto-update

CLI: --auto-update=[on|off]

Property: liquibase.command.checks.show.autoUpdate: [on|off]

Environment Variable: LIQUIBASE_COMMAND_CHECKS_SHOW_AUTO_UPDATE=[ON|OFF]

Allows automatic backup and updating of the liquibase.check-settings.conf file when new quality checks are available.

Default: off

format

CLI: --format=[text|json]

Property: liquibase.command.checks.show.format: [text|json]

Environment Variable: LIQUIBASE_COMMAND_CHECKS_SHOW_FORMAT=[TEXT|JSON]

Liquibase Pro only. Sets the format of the check output to text or JSON.

Default: text

For more information, see Quality Checks JSON Object .

Related links