checks customize

The customize subcommand allows you to customize dynamic checks specified in your check configurations – --checks-settings-file.

Uses

Using the customize subcommand, you can provide your values or change the default values of checks that have customization options.

Examples include lists of data types, Change Types, strings, or regular expressions that should be reported, and others.

Liquibase does not allow you to customize static checks.

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

Running the checks customize 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 customize --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. Enter the value you want to change.

The command will update the value of a check in the checks settings file. To execute the check, use the checks run.

checks customize 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 Using the Checks Settings Configuration 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.

auto-update

CLI: --auto-update=[on|off]

Property: liquibase.command.checks.customize.autoUpdate: [on|off]

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

Related links