Quality Checks Commands

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

To execute quality checks and improve the quality of your database changes, use the checks command group and subcommands.

Tip: If you use Maven, see Maven checks.show and Maven checks.run.

To validate that multiple types of objects in your database adhere to your naming conventions, use the Multiple Objects Quality Check.

If you have Liquibase Pro, you can format the output of your quality checks as JSON. For more information, see Quality Checks JSON Object.

For more information about using quality checks, see Working with Quality Checks .

checks command

The liquibase checks command is a command group with subcommands that let you customize and execute quality checks.

  • Subcommands require specific parameters noted in the table.
  • Customizations to checks configuration are stored in the checks settings file.

checks subcommands




The copy subcommand copies a customizable check so that you can run the same check multiple times with different parameters. It requires the --check-name parameter.


The customize subcommand allows you to customize checks specified in your check configurations. It requires the --check-name parameter.


The delete subcommand allows you to delete a copy of a check from your checks settings. You cannot delete static checks and parent dynamic checks used to create copies of checks.


The disable subcommand disables a specific check provided in the --check-name parameter. The liquibase run checks command does not evaluate disabled checks when being executed.


The enable subcommand enables a specific check provided in the --check-name parameter. The liquibase run checks command evaluates enabled checks when being executed.


The reset subcommand reverts customizations made to the check indicated in the --check-name parameter to default settings. This subcommand does not affect static checks and uncustomized dynamic checks.

Note: When resetting a dynamic check that has been customized multiple times, the check will be reverted to default settings and not to the previous customized settings.


The run subcommand executes checks using the checks settings file and the changelog file you specify. It requires the --changelog-file parameter.


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

bulk-set The bulk-set command sets all qualifying quality checks to the same value. The command is a Liquibase Pro command, so you need a valid Liquibase Pro License Key to use it.

checks command group parameters

The following table identifies parameters that are accepted or required by some subcommands.

Tip: All Commands and Parameters use the --kabob-case format in the CLI environment.

Name Syntax Description





Environment Variable:


The parameter which specifies the needed checks settings file to work with subcommands.

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






Environment Variable:


The parameter which you must specify so that any of the following subcommands being executed can perform its function:

  • copy
  • customize
  • delete
  • disable
  • enable
  • reset





Environment Variable:


The changelog file against which you execute checks when running liquibase run.