timestampColumnName

timestampColumnName is a custom policy check that ensures all columns of a specified type include a postfix such as timestamp columns must include _ts at the end.

Learn how to create and customize the timestampColumnName Liquibase Custom Policy Check using a Python script.

This example works for relational databases. You can use this check as it is or customize it further to fit your needs in your SQL database.

For a conceptual overview of this feature, see Liquibase Pro Custom Policy Checks.

Scope	Database
Database	Relational

Step-by-step

These steps describe how to create the Custom Policy Check. It does not exist by default in Liquibase Pro.

1. Create a Check Settings file: Use the Checks Settings Configuration File

2. Add this code to your Checks Settings file:

   Copy

   timestampColumnName Quotes Python Script

   ###
   ### This script checks ensures that all columns of a specified type include a postfix
   ### e.g., timestamp columns must include _ts at the end
   ###
   ### Notes:
   ###
   
   ###
   ### Helpers come from Liquibase
   ###
   import liquibase_utilities
   import sqlparse
   import sys
   
   ###
   ### main
   ###
   
   ###
   ### Retrieve log handler
   ### Ex. liquibase_logger.info(message)
   ###
   liquibase_logger = liquibase_utilities.get_logger()
   
   ###
   ### Retrieve status handler
   ###
   liquibase_status = liquibase_utilities.get_status()
   
   ###
   ### Retrive column information from check definition
   ###
   column_check = liquibase_utilities.get_arg("COLUMN_TYPE").casefold()
   column_postfix = liquibase_utilities.get_arg("COLUMN_POSTFIX").casefold()
   
   ###
   ### Retrieve all changes in changeset
   ###
   changes = liquibase_utilities.get_changeset().getChanges()
   
   ###
   ### Loop through all changes
   ###
   for change in changes:
       ###
       ### LoadData change types are not currently supported
       ###
       if "loaddatachange" in change.getClass().getSimpleName().lower():
           liquibase_logger.info("LoadData change type not supported. Statement skipped.")
           continue
       ###
       ### Retrieve sql as string, remove extra whitespace, split into statements
       ###
       raw_sql = liquibase_utilities.strip_comments(liquibase_utilities.generate_sql(change)).casefold()
       raw_sql = " ".join(raw_sql.split())
       raw_statements = liquibase_utilities.split_statements(raw_sql)
       ###
       ### Process each statement
       ###
       for raw_statement in raw_statements:
           column_list_detail = []
           is_create, is_table = False, False
           token_list = [token for token in liquibase_utilities.tokenize(raw_statement) if not token.is_whitespace]
           for token in token_list:
               if token.ttype == sqlparse.tokens.DDL and token.value == "create":
                   is_create = True
               elif is_create and token.ttype == sqlparse.tokens.Keyword and token.value == "table":
                   is_table = True
               elif is_create and is_table and token.value.startswith("("):
                   columns = token.value[1:token.value.rfind(")")].replace("\n","").split(",")
                   for column in columns:
                       column_list_detail.append(' '.join(column.split()).split())
                   break
           if (is_create == False or is_table == False):
               liquibase_logger.info(f"Non create table statement skipped: {raw_statement}")
               continue
           ###
           ### Process column list
           ###
           postfix_len = len(column_postfix)
           for column in column_list_detail:
               column_name = column[0].replace("\"","")
               column_type = column[1]
               if column_type == column_check and column_name[-postfix_len:] != column_postfix:
                   liquibase_status.fired = True
                   status_message = str(liquibase_utilities.get_script_message()).replace("__COLUMN_NAME__", f"\"{column_name}\"")
                   status_message = status_message.replace("__COLUMN_POSTFIX__", f"\"{column_postfix}\"")
                   liquibase_status.message = status_message
                   sys.exit(1)
   
   ###
   ### Default return code
   ###
   False

3. Initiate the customization process. In the CLI, run this command:
   liquibase checks customize --check-name=CustomCheckTemplate
   The CLI prompts you to finish configuring your file. A message displays:

   This check cannot be customized directly because one or more fields does not have a default value.

   Liquibase will then create a copy of CustomCheckTemplate and initiate the customization workflow.

4. Give your check a short name so you can easily identify what Python script it is associated with (up to 64 alpha-numeric characters only).
   In this example we will name the check:
   timestampColumnName

5. Set the Severity to return a code of 0-4 when triggered. These severity codes allow you to determine if the job moves forward or stops when this check triggers.
   Learn more here: Use Policy Checks in Automation: Severity and Exit Code
   options: 'INFO'=0, 'MINOR'=1, 'MAJOR'=2, 'CRITICAL'=3, 'BLOCKER'=4

6. Set SCRIPT_DESCRIPTION. In this example, we will set the description to:

   This script ensures that all columns include _ts at the end.

7. Set SCRIPT_SCOPE. In this example, we will set the scope to changelog.
• changelog: for example, if your check looks for syntax patterns or attributes in your Liquibase Changelog (the changes you author in your repository). With this value, the check runs once per changeset.
8. Set the SCRIPT_MESSAGE. This message will display when the check is triggered. In this example we will use:
   Column name __COLUMN_NAME__ must include __COLUMN_POSTFIX__. It is recommended this be fixed before proceeding.
9. Set the SCRIPT_PATH. This is the relative path where your script is stored in relation to the changelog specified in --changelog-file, whether it is stored locally or in a repository.
   In this example, we will set the path to: scripts/timestamp-column-name.py.
10. Set the SCRIPT_ARGUMENT to COLUMN_TYPE=TIMESTAMP, COLUMN_POSTFIX=_TS.
    This allows you to pass dynamic information into the Custom Policy Check without modifying the Python code.
    When you set DATA_TYPE=CLOB in the CLI, you can retrieve it in your code with both of these variables: 
    column_type = liquibase_utilities.get_arg("COLUMN_TYPE")
column_postfix = liquibase_utilities.get_arg("COLUMN_POSTFIX")
    If you checks customize your check later, you can specify a new value in the CLI. If you don't need dynamic arguments, leave this field blank.
11. Set the REQUIRES_SNAPSHOT. If your script scope is changelog, set whether the check requires a database snapshot. Specify true if your check needs to inspect database objects. (If your script scope is database, Liquibase always takes a snapshot, so this prompt does not appear.)

Note: The larger your database, the more performance impact a snapshot causes. If you cannot run a snapshot due to memory limitations, see Memory Limits of Inspecting Large Schemas.

You have now successfully created and customized a policy check!

Next steps

• Run a Custom Policy Check

Related Topics

Sample Custom Policy Check Scripts