TableCommentCheck

Last updated: July 14, 2025

The TableCommentCheck check allows you to flag any table that does not have a comment. Note that this is not a check for a Liquibase changelog comment.

Uses

Property

Value

Liquibase version required

4.12.0+

Scope (--checks-scope)

changelog, database

Default status

disabled

Default severity (exit code)

0 ("INFO")

Customizable settings

No (static)

You can use the check to check for the presence of a comment within a table described in a changelog. Comments explain the purpose of a table for anyone viewing the table.

Before you begin

  1. Ensure that you have correctly specified your Liquibase Pro license key.

  2. Ensure that the --checks-scope parameter includes the scope of this check.

Changelog checks prerequisites

--license-key=<string>
--checks-scope=<string>

Procedure

1

Enable

This check is disabled by default. To enable it, run the checks enable command:

liquibase checks enable --check-name=<string>

2

To run the check, use the checks run command.

liquibase checks run --check-name=<string>

Note: For flow files you'll need to run liquibase flow to apply your changes.

TableCommentCheck - Liquibase