delete

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.

You cannot delete static checks and parent dynamic checks used to create copies of checks.

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

Running the delete command

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.

  2. Confirm that you want to do the change.

The command will update the checks settings file.

delete command attributes

Tip: All commands and parameters use the --kebab-case format in the CLI environment. This is the format Liquibase recommends for best results. 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.delete.checksSettingsFile

Environment Variable:

LIQUIBASE_COMMAND_CHECKS_DELETE_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.delete.checkName

Environment Variable:

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

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

Default: off

Related links