CreateTableMustHavePrimaryKey
Last updated: February 16, 2026
Before you begin
Scope | Database |
changelog | Cassandra |
Liquibase 4.29.0+
Configure a valid Liquibase Pro license key
Ensure the Liquibase Checks extension is installed. In Liquibase 4.31.0+, it is already installed in the
/liquibase/internal/libdirectory, so no action is needed.If the checks JAR is not installed, download
liquibase-checks-<version>.jarand put it in theliquibase/libdirectory.Maven users only:
Add this dependency to your
pom.xmlfile:
<dependency> <groupId>org.liquibase.ext</groupId> <artifactId>liquibase-checks</artifactId> <version>2.0.0</version> </dependency>
Java Development Kit 17+ (available for Open JDK and Oracle JDK)
Linux, macOS, or Windows operating system
Procedure
These steps describe how to create the Custom Policy Check. It does not exist by default in Liquibase Pro.
Run this command in the CLI:
liquibase checks customize --check-name=SqlUserDefinedPatternCheckGive your check a short name for easy identification
Use up to 64 alpha-numeric characters only.
CreateTableMustHavePrimaryKeySet 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
Set the SEARCH_STRING to this valid regular expression:
Regular expression search string
(?is)(?=.*\b(create)\b)(?=.*\b(table)\b)(?!.*\b(primary)\b)(?!.*\b(key)\b).*Set the MESSAGE to display when a match for the regular expression <SEARCH_STRING> is found in a Changeset.
Error! CREATE TABLE statement must have a primary key included.
Set STRIP_COMMENTS to true if you want to remove the comments from the output.
The regex custom policy check is created successfully.
Sample Passing Script
--changeset amalik:employee
CREATE TABLE EMPLOYEE (
EMPLOYEE_ID INT NOT NULL GENERATED ALWAYS AS IDENTITY CONSTRAINT PEOPLE_PK PRIMARY KEY,
FIRST_NAME VARCHAR(26),
LAST_NAME VARCHAR(26)
);
--changeset amalik:company
CREATE TABLE COMPANY (
COMPANY_ID INT NOT NULL,
BOOKING_DATE DATE NOT NULL,
ROOMS_TAKEN INT DEFAULT 0,
PRIMARY KEY (COMPANY_ID, BOOKING_DATE)
);
Sample Failing Scripts
--changeset amalik:employee
CREATE TABLE EMPLOYEE (
EMPLOYEE_ID INT NOT NULL GENERATED ALWAYS AS IDENTITY CONSTRAINT PEOPLE_PK,
FIRST_NAME VARCHAR(26),
LAST_NAME VARCHAR(26)
);
--changeset amalik:company
CREATE TABLE COMPANY (
COMPANY_ID INT NOT NULL,
BOOKING_DATE DATE NOT NULL,
ROOMS_TAKEN INT DEFAULT 0,
;
Sample Error Message
CHANGELOG CHECKS
----------------
Checks completed validation of the changelog and found the following issues:
Check Name: Check for specific patterns in sql (CreateTableMustHavePrimaryKey)
Changeset ID: employee
Changeset Filepath: changeLogs/1_tables/01_createTable1.sql
Check Severity: INFO (Return code: 0)
Message: Error! CREATE TABLE statement must have a primary key
included.