reset

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 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 view a list of available checks, run liquibase checks show.

Running the 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 the change.

The command updates the check in the checks settings file.

reset command attributes

Name Syntax Description
checks-settings-file

CLI:

--checks-settings-file

Property:

liquibase.command.checks.reset.checksSettingsFile

Environment Variable:

LIQUIBASE_COMMAND_CHECKS_RESET_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.reset.checkName

Environment Variable:

LIQUIBASE_COMMAND_CHECKS_RESET_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.reset.autoUpdate: [on|off]

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