show
Note: This is a Liquibase Pro feature, so you need a Liquibase Pro License Key to use it.
The show subcommand prints the available checks and their configurations as indicated in the checks settings file to STDOUT.
Uses
You can use the show command to see the list of all available checks and inspect the dynamic checks.
Syntax
Run the command specifying your values:
liquibase checks showNote: 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. See Use the Checks Settings Configuration File.
The command output will present your checks and their details.
Command arguments
The following table identifies parameters that are accepted or required by the show subcommand. If the Default column states "Required," it is required to run the command successfully. If it states "Null," it is an optional command argument. Each command argument helps you narrow down the liquibase checks show command to ensure that only very specific content is affected by the command.
Tip: For best results, specify all commands and parameters in the --kebab-case format in the CLI. If your preference is camelCase, it also works in the CLI.
| Name | Default | Syntax | Description |
|---|---|---|---|
auto-update (String) |
Null |
CLI: Property: Environment Variable: |
Allows automatic backup and updating of the Default: off |
check-name (String) |
Null |
CLI: Property: Environment Variable: |
Use this to specify the short name of the check you want to target with one of the following subcommands:
|
checks-settings-file(String) |
Null |
CLI: Property: Environment Variable: |
Specifies the checks settings file to use with subcommands. Write the relative path of the settings file that you want to read from or modify. For more information, see Use the Checks Settings Configuration File. |
--package-file (String) |
Null | CLI: liquibase checks run --packages-file=securuity-checks.pkgProperty: |
The file name of the yaml file to be created. defaults to liquibase.checks-package.yaml if not set. For more information see Quality Checks Packages |
--package-name (String) |
Null | CLI: liquibase checks run --packages-name=security-checks.pkgProperty: |
The name of the checks-package object inside the file to be created. For more information see Quality Checks Packages |
--package-contents (String) |
Null | CLI: liquibase checks run --packages-contents=security-checks.pkgProperty: |
The file, files, or dir of files to be included in the |
showCols (String) |
shortname,scope, enabled,severity, customization,description |
CLI: Property: Environment Variable: |
Only show the listed columns. Column options: id,checkname,type,priority,shortname,scope,enabled,severity,customization,description. Use commas to separate column names. Use 'all' to select all the columns. |
show example output
Starting Liquibase at 15:56:16 (version 4.19.0 #6648 built at 2023-01-17 15:02+0000)
Liquibase Version: 4.19.0
Liquibase Open Source 4.19.0 by Liquibase
Generating report on current configuration of checks using settings in: liquibase.checks-settings.conf
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| Short Name | Scope | Enabled | Severity | Customization | Description |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| SqlGrantWarn | changelog | true | 0 | None | This check warns a user when |
| | | | | | SQL contains 'GRANT' |
| | | | | | statements so that they can |
| | | | | | ensure that the privilege |
| | | | | | being granted won't lead to |
| | | | | | security issues. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| SqlRevokeWarn | changelog | true | 0 | None | This check warns a user when |
| | | | | | SQL contains 'REVOKE' |
| | | | | | statements so that they can |
| | | | | | ensure that the privilege |
| | | | | | being revoked won't lead to |
| | | | | | data access and dependency |
| | | | | | issues. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| WarnOnUseDatabase | changelog | true | 0 | None | This check warns a user when |
| | | | | | generated or raw SQL contains |
| | | | | | 'USE DATABASE' directive. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| ChangeDropTableWarn | changelog | true | 0 | None | This check warns a user when a |
| | | | | | table is being dropped so that |
| | | | | | they can ensure that dropping |
| | | | | | the table won't lead to |
| | | | | | unintentional loss of data. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| ChangeDropColumnWarn | changelog | true | 0 | None | This check warns a user when a |
| | | | | | column is being dropped so |
| | | | | | that they can ensure that |
| | | | | | dropping the column won't lead |
| | | | | | to unintentional loss of data. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| ModifyDataTypeWarn | changelog | true | 0 | None | This check warns a user when a |
| | | | | | change will result in |
| | | | | | modification of a data type so |
| | | | | | they can ensure that modifying |
| | | | | | the data type won't lead to |
| | | | | | unintentional loss of data |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| SqlSelectStarWarn | changelog | true | 0 | None | This check warns a user when |
| | | | | | generated or raw SQL contains |
| | | | | | 'SELECT *' statements so that |
| | | | | | they can ensure selecting all |
| | | | | | fields from a table in a query |
| | | | | | is safe and necessary |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| SqlUserDefinedPatternCheck | changelog | false | 0 | SEARCH_STRING = null | This check scans SQL for the |
| | | | | MESSAGE = A match for regular | presence of specific patterns |
| | | | | expression SEARCH_STRING was | and warns the user when they |
| | | | | detected in Changeset | are found. |
| | | | | CHANGESET. | |
| | | | | STRIP_COMMENTS = true | |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| TableColumnLimit | changelog, | true | 0 | MAX_COLUMNS = 50 | Ensures that no table has more |
| | database | | | | than a threshold number of |
| | | | | | columns. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| ObjectNameMustMatch | changelog, | false | 0 | OPERATOR = STARTS_WITH | This check confirms the listed |
| | database | | | SEARCH_STRING = null | object names conform to the |
| | | | | OBJECT_TYPES = null | supplied pattern. |
| | | | | CASE_SENSITIVE = true | |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| ObjectNameMustNotMatch | changelog, | false | 0 | OPERATOR = STARTS_WITH | This check confirms the listed |
| | database | | | SEARCH_STRING = null | object names do not match the |
| | | | | OBJECT_TYPES = null | supplied pattern. |
| | | | | CASE_SENSITIVE = true | |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| SqlGrantSpecificPrivsWarn | changelog | false | 0 | PRIVILEGE_LIST = null | This check warns a user when |
| | | | | | changeset includes or |
| | | | | | generates sql that grants |
| | | | | | specific privileges to a user |
| | | | | | or role |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| ChangeTruncateTableWarn | changelog | true | 0 | None | This check warns a user when a |
| | | | | | table is being truncated so |
| | | | | | that they can ensure that |
| | | | | | truncating the table won't |
| | | | | | lead to unintentional loss of |
| | | | | | data. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| SqlGrantOptionWarn | changelog | true | 0 | None | This check warns a user when |
| | | | | | SQL contains 'GRANT' |
| | | | | | statements that include the |
| | | | | | 'WITH GRANT OPTION' clause so |
| | | | | | that they can ensure that the |
| | | | | | privilege being granted won't |
| | | | | | lead to security issues |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| OracleReservedKeywords | changelog | false | 0 | OBJECT_TYPES = null | Disallow Oracle reserved |
| | | | | ALLOWED_LIST = null | keywords from being used in |
| | | | | CASE_SENSITIVE = true | database object names. See |
| | | | | | https://docs.oracle.com/cd/B19 |
| | | | | | 306_01/em.102/b40103/app_oracl |
| | | | | | e_reserved_words.htm for |
| | | | | | complete list of keywords. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| SQLServerReservedKeywords | changelog | false | 0 | OBJECT_TYPES = null | Disallow SQL Server reserved |
| | | | | ALLOWED_LIST = null | keywords from being used in |
| | | | | CASE_SENSITIVE = true | database object names. See |
| | | | | | https://docs.microsoft.com/en- |
| | | | | | us/sql/t-sql/language-elements |
| | | | | | /reserved-keywords-transact-sq |
| | | | | | l?view=sql-server-ver16 for |
| | | | | | complete list of keywords. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| SQLServerFutureReservedKeywords | changelog | false | 0 | OBJECT_TYPES = null | Disallow SQL Server's future |
| | | | | ALLOWED_LIST = null | reserved keywords from being |
| | | | | CASE_SENSITIVE = true | used in database object names. |
| | | | | | See |
| | | | | | https://docs.microsoft.com/en- |
| | | | | | us/sql/t-sql/language-elements |
| | | | | | /reserved-keywords-transact-sq |
| | | | | | l?view=sql-server-ver16 for |
| | | | | | complete list of keywords. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| PostgresReservedKeywords | changelog | false | 0 | OBJECT_TYPES = null | Disallow Postgres reserved |
| | | | | ALLOWED_LIST = null | keywords from being used in |
| | | | | CASE_SENSITIVE = true | database object names. See |
| | | | | | https://www.postgresql.org/doc |
| | | | | | s/14/sql-keywords-appendix.htm |
| | | | | | l for complete list of |
| | | | | | keywords. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| SQLServerODBCReservedKeywords | changelog | false | 0 | OBJECT_TYPES = null | Disallow SQL Server's ODBC |
| | | | | ALLOWED_LIST = null | reserved keywords from being |
| | | | | CASE_SENSITIVE = true | used in database object names. |
| | | | | | See |
| | | | | | https://docs.microsoft.com/en- |
| | | | | | us/sql/t-sql/language-elements |
| | | | | | /reserved-keywords-transact-sq |
| | | | | | l?view=sql-server-ver16 for |
| | | | | | complete list of keywords. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| PostgresNonReservedKeywords | changelog | false | 0 | OBJECT_TYPES = null | Disallow Postgres non-reserved |
| | | | | ALLOWED_LIST = null | keywords from being used in |
| | | | | CASE_SENSITIVE = true | database object names. See |
| | | | | | https://www.postgresql.org/doc |
| | | | | | s/14/sql-keywords-appendix.htm |
| | | | | | l for complete list of |
| | | | | | keywords. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| SqlGrantAdminWarn | changelog | true | 0 | None | This check warns a user when |
| | | | | | SQL contains 'GRANT' |
| | | | | | statements that include the |
| | | | | | 'WITH ADMIN OPTION' clause so |
| | | | | | that they can ensure that the |
| | | | | | privilege being granted won't |
| | | | | | lead to security issues |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| DetectChangeType | changelog | true | 0 | CHANGE_TYPE_LIST = | This check warns a user when a |
| | | | | dropTable,dropColumn | ChangeSet includes a |
| | | | | | ChangeType listed by the user |
| | | | | | as forbidden |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| RollbackRequired | changelog | true | 0 | None | This check triggers when a |
| | | | | | changeset does not have a |
| | | | | | rollback defined. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| ChangesetLabelCheck | changelog | true | 0 | None | This check enforces the |
| | | | | | Liquibase recommendation that |
| | | | | | labels be assigned to each |
| | | | | | changeset to provide better |
| | | | | | deployment control and to |
| | | | | | enhance traceability of |
| | | | | | efforts across changesets. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| ChangesetContextCheck | changelog | true | 0 | None | This check enforces the |
| | | | | | Liquibase recommendation that |
| | | | | | contexts be assigned to each |
| | | | | | changeset to provide better |
| | | | | | deployment control and to |
| | | | | | enhance traceability of |
| | | | | | efforts across changesets. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| ChangesetCommentCheck | changelog | true | 0 | None | This check enforces the |
| | | | | | Liquibase recommendation that |
| | | | | | comments be added to each |
| | | | | | changeset to document the |
| | | | | | purpose of a changeset for |
| | | | | | other/future consumers of this |
| | | | | | changelog |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| PrimaryKeyOnCreateTable | changelog | true | 0 | EXCEPTIONS_LIST = | This check warns when a create |
| | | | | CASE_SENSITIVE = true | table action doesn't also |
| | | | | | include a primary key. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| CheckTablesForIndex | database | true | 0 | None | This check scans your target |
| | | | | | URL database tables to find |
| | | | | | tables which do not have an |
| | | | | | associated index. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| TableCommentCheck | database | false | 0 | None | This database check flags any |
| | | | | | table which does not have a |
| | | | | | comment. (Note: This is not a |
| | | | | | check for a Liquibase |
| | | | | | changelog comment.) |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| TableCommentPatternCheck | changelog, | false | 0 | OPERATOR = CONTAINS | This check triggers when |
| | database | | | SEARCH_STRING = null | specific user-supplied |
| | | | | MESSAGE = A match for regular | patterns are found in Table |
| | | | | expression SEARCH_STRING was | Comments. |
| | | | | detected in IDENTIFIER. | |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| ConstraintMustExist | database | false | 0 | CONSTRAINT_OPERATOR = | Check for and alert when |
| | | | | STARTS_WITH | specified table does not |
| | | | | TABLE_NAME = null | contain the required |
| | | | | COLUMN_NAME = null | constraint(s). |
| | | | | CONSTRAINT = PRIMARYKEY | |
| | | | | CASE_SENSITIVE = true | |
| | | | | MESSAGE = The specified table | |
| | | | | 'TABLE_NAME' does not | |
| | | | | contain the required | |
| | | | | 'CONSTRAINT' constraint. | |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
| RequireChangesetIDisUUID | changelog | false | 0 | None | Alerts when a changeset ID |
| | | | | | does not follow the 8-4-4-4-12 |
| | | | | | pattern of UUID or GUID. |
+---------------------------------+------------+---------+----------+--------------------------------+--------------------------------+
INFO: Customize 'checks show' table with --show-cols flag. Learn more with 'liquibase checks show --help'
Liquibase command 'checks show' was executed successfully.