Maven checks.show

To maintain or improve the quality of your database changes, get started with quality checks: Working with Quality Checks and Configure Quality Checks. Maven supports the checks.show and checks.run goals. If you need to customize quality checks, use the Liquibase CLI, which supports interactive mode for copy, customize, delete, disable, enable, reset, and bulk-set. See Quality Checks Commands.

Description

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

Uses

Use the checks.show goal to see the list of all available checks with their settings and decide which checks to run.

Maven configuration

You can configure Liquibase Maven in multiple ways. One way is to define your Liquibase configuration properties in the pom.xml file. To configure the pom.xml file, refer to Configuring Liquibase Attributes in your Maven POM File.

Tip: The Liquibase properties file and environment variables are the alternative options for Liquibase configuration. For more information about the Maven configuration, see Configuring Maven.

Checks settings file configuration

When you start using the quality checks functionality by running any checks goal, Liquibase identifies the need for a checks settings file:

  • To create the default checks settings file named liquibase.check-settings.conf in the Liquibase working directory, enter Y at runtime.
  • To use the in-memory file while running checks.run or checks.show, enter N at runtime. Other subcommands require a checks settings file to save the changes for checks.
  • To use a checks settings file customized for a specific environment or project, pass it with the checks settings file parameter. If you do not include the parameter, Liquibase uses the in-memory file or default settings file – liquibase.checks-settings.conf.

Running the checks.show Maven goal

Running the checks.show goal requires you to have a Maven project implemented.

To run the goal, enter the following at your command prompt:

mvn liquibase:checks.show

checks.show Maven configuration properties

Property Definition

CLI: -Dliquibase.checksSettingsFile

Property in the pom.xml file: <checksSettingsFile>path/to/checks-settings.conf</checksSettingsFile>

Environment variable: LIQUIBASE_COMMAND_CHECKS_SHOW_CHECKS_SETTINGS_FILE

This is the parameter that specifies the needed checks settings file to work with goals.

Set the checksSettingsFile parameter to the relative path of the checks settings file which you want to use or modify.

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