NoDeleteWithoutWhere
NoDeleteWithoutWhere is a custom policy check that requires every DELETE statement to also have a WHERE statement.
regex: (?is)(?=.*\b(delete)\b)(?!.*\b(where)\b).*
This example utilizes Oracle. 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 | Oracle |
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/lib
directory, so no action is needed.If the checks JAR is not installed, download
liquibase-checks-<version>.jar
and put it in theliquibase/lib
directory.Maven users only:
Add this dependency to your pom.xml
file:
<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=SqlUserDefinedPatternCheck
Give your check a short name for easy identification
Use up to 64 alpha-numeric characters only.
In this example we will use:
NoDeleteWithoutWhere
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
Set the SEARCH_STRING to this valid regular expression:
Regular expression search string
(?is)(?=.*\b(delete)\b)(?!.*\b(where)\b).*
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:
All DELETE statements must have a WHERE clause.
Set STRIP_COMMENTS to true if you want to remove the comments from the output.
Set the SCRIPT_SCOPE.
In this example, we will set the scope to changelog.
changelog scope: 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.
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.