checks reset command

The reset subcommand reverts customizations made to the check indicated in the --check-name parameter to the original configuration.

Uses

You can typically use the check reset command to return to a reliable starting state when working with checks. This subcommand does not affect static checks and uncustomized dynamic checks.

When resetting a dynamic check that has been customized multiple times, the check will be reverted to default settings and not to the previous customized settings.

Note: To see the list of available checks, run liquibase checks show.

Running the checks reset 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 reset --check-name=TableColumnLimit

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

checks reset command attributes

Name Syntax Description
checks-settings-file

CLI:

--checks-settings-file

Property:

liquibase.command.checks.<subcommand>.checksSettingsFile

Environment Variable:

LIQUIBASE_COMMAND_CHECKS_<subcommand>_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 checks settings file.

check-name

CLI:

--check-name

Property:

liquibase.command.checks.<subcommand>.checkName

Environment Variable:

LIQUIBASE_COMMAND_CHECKS_<subcommand>_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.

Related links