DoNotUseQaOrProdDatabases
DoNotUseQaOrProdDatabases is a custom policy check that prevents the use of *_QA or *_PROD databases when deployment is restricted to *_DEV database only.
regex: (?is)(?=create|drop|alter|insert|select|delete).*(?:_prod|_qa)\.
This example utilizes Snowflake. You can use this check as it is or customize it further to fit your needs in your SQL database. All Regex Custom Policy Checks can only run against the changelog, not against the database.
Before you begin
Scope | Database |
changelog | Snowflake |
Liquibase 4.29.0+
Configure a valid Liquibase Pro license key
Create a Check Settings file: Use the Checks Settings Configuration File
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.
In this example we will use:
DoNotUseQaOrProdDatabasesSet 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)(?=create|drop|alter|insert|select|delete).*(?:_prod|_qa)\.Set the MESSAGE to display when a match for the regular expression <SEARCH_STRING> is found in a Changeset.
In this example we will use:
Error! Do not use *_QA or *_PROD databases (deployment is restricted to *_DEV databases only)