enable

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

Uses

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

Note: To view a list of available checks, run liquibase checks show.

Running the 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 enables the check in the checks settings file. To run the check, use the run command.

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.enable.checksSettingsFile

Environment Variable: LIQUIBASE_COMMAND_CHECKS_ENABLE_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 .

check-name

CLI: --check-name

Property: liquibase.command.checks.enable.checkName

Environment Variable: LIQUIBASE_COMMAND_CHECKS_ENABLE_CHECK_NAME

Use this to specify the short name of the check you want to target with one of the following subcommands:

  • copy
  • customize
  • delete
  • disable
  • enable
  • reset
  • run
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]

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

Default: off

Related links