checks enable

The enable subcommand enables a specific check provided in the --check-name parameters.

Uses

You can typically use the checks enable command to start or continue executing the disabled check. The liquibase checks run command evaluates enabled checks when being executed.

Note: To see the list of available checks, run liquibase checks show.

Running the checks enable command

Run the command specifying your values:

liquibase checks enable --check-name=ChangesetCommentCheck

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 will enable the check in the checks settings file. To execute the check, use the checks run.

checks enable command attributes

Name Syntax Description
checks-settings-file

CLI:

--checks-settings-file

Property:

liquibase.command.checks.<subcommand>.checksSettingsFile

Environment Variable:

LIQUIBASE_COMMAND_CHECKS_<subcommand>_CHECKS_SETTINGS_FILE

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

Set the checks-settings-file parameter to the relative path of the checks-settings-file that you want to read from or modify.

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

check-name

CLI:

--check-name

Property:

liquibase.command.checks.<subcommand>.checkName

Environment Variable:

LIQUIBASE_COMMAND_CHECKS_<subcommand>_CHECK_NAME

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

Set the check-name parameter to the short name for the check you want to target with one of the subcommands.

auto-update

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

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

Environment Variable: LIQUIBASE_COMMAND_CHECKS_ENABLE_AUTO_UPDATE=[ON|OFF]

The parameter which allows automatic backup and updating of the liquibase.check-settings.conf file when new quality checks are available.

Related links