disable

The disable subcommand disables a specific check provided in the --check-name parameters.

Uses

You can typically use the disable command to stop executing a check you no longer require. The liquibase checks run command does not evaluate disabled checks when you execute it.

If you use Liquibase Community, the execution of checks is limited to five. You can disable and enable available checks to focus on the checks that are most important to you. Liquibase Pro allows you to enable and execute an unlimited number of checks.

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

Running the disable command

Run the command specifying your values:

liquibase checks disable --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 disable the check in the checks settings file.

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

Environment Variable: LIQUIBASE_COMMAND_CHECKS_DISABLE_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.disable.checkName

Environment Variable: LIQUIBASE_COMMAND_CHECKS_DISABLE_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.disable.autoUpdate: [on|off]

Environment Variable: LIQUIBASE_COMMAND_CHECKS_DISABLE_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