disable

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

The disable subcommand disables a specific check. You can specify which check to disable using the --check-name parameter.

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.

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

Syntax

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. See Use the Checks Settings Configuration File.

The command disables the check in the checks settings file.

Command arguments

The following table identifies parameters that are accepted or required by the disable subcommand. If the Default column states "Required," it is required to run the command successfully. If it states "Null," it is an optional command argument. Each command argument helps you narrow down the liquibase checks disable command to ensure that only very specific content is affected by the command.

Tip: For best results, specify all commands and parameters in the --kebab-case format in the CLI. If your preference is camelCase, it also works in the CLI.

Name Default Syntax Description
check-name(String) Required

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:

  • bulk-set
  • copy
  • customize
  • delete
  • disable
  • enable
  • reset
  • run
  • show
checks-settings-file(String) Null

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 Use the Checks Settings Configuration File.

auto-update(String) Null

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.checks-settings.conf file when new quality checks are available.

Default: off

Related links