checks create

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

The checks create command allows you to create a new YAML checks package file. Learn more about Checks packages here: Policy Checks Packages. It is available in Liquibase 4.25.0 and later.

Uses

Using the checks create command alongside the checks command creates a new YAML checks package file. This checks package file contains several package objects, which in turn contain checks settings files which enable or disable any Policy check you want. This lets you run a bundle of checks at once rather than one at a time.

To use this command, you must have a checks package file.

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

Syntax

checks create command

Creates a new YAML checks package file. If you specify a file that does not exist, Liquibase will create it.

UNIX example

liquibase checks create \ --package-file=my-package-file.yaml \ --package-name=my-first-package \ --package-contents=liquibase.checks-settings.conf

Windows example

liquibase checks create ^ --package-file=my-package-file.yaml ^ --package-name=my-first-package ^ --package-contents=liquibase.checks-settings.conf

This results in a package file called my-package-file.yaml. The file contains one package object (my-first-package), which contains the one checks settings file you created:

checksPackages: - name: platform-checks files: - liquibase.checks-settings.conf

Parameters

Global parameters

Attribute

Definition

Requirement

--license-key=<string>

Your Liquibase Pro license key

Required

Command parameters

Attribute

Description

Requirement

--package-contents=<string>

One or more comma-separated relative path(s) to the checks settings files (or to a directory of files) to be bundled into the checks package. If the value is a directory, all files will be added to the --package-name object, but not recursively.

Required

--package-name=<string>

The name of the checks package object to be created inside the checks package YAML file.

Required

--package-file=<string>

The relative or fully qualified path and filename of the YAML file to create. Default: liquibase.checks-package.yaml.

Optional

Output

INFO: SUCCESS! 'my-package-file.yaml' was created, and the specified file at 'liquibase.checks-settings.conf' were added to new checks package named 'my-first-package'. Use this checks package with 'liquibase checks show --checks-settings-file=my-package-file.yaml --checks-packages=my-first-package' Liquibase command 'checks create' was executed successfully.

checks create - Liquibase