delete

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

The delete subcommand allows you to delete a copy of a dynamic check from the checks configuration in the checks settings file.

Uses

You can typically use the delete command to remove checks you have made in error or checks you no longer need to keep your checks configuration concise and maintainable.

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

Syntax

The command is interactive, and you need to follow the CLI output messages to execute it:

  1. Run the command specifying your values:

    liquibase checks delete --check-name=TableColumnLimit1

    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.

  2. Confirm that you want to do the change. The command updates the checks settings file.

Command arguments

The following table identifies parameters that are accepted or required by the delete 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 delete 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.delete.checkName

Environment Variable: LIQUIBASE_COMMAND_CHECKS_DELETE_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.delete.checksSettingsFile

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

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