`NoCursor`

NoCursor is a custom policy check that prevents the use of CURSOR statements.

regex: (?i:\scursor\s)

This example utilizes SQL Server. 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.

Scope	Database
changelog	SQL Server

Liquibase Prerequisites

Step-by-Step

Note: These steps describe how to create the custom policy check. It does not exist by default in Liquibase Pro.

Enter this command into the CLI:
liquibase checks customize --check-name=SqlUserDefinedPatternCheck
Give your check a short name for easier identification. In this example we will title the check:
NoCursor
Set the Severity to return a code of 0-4 when triggered.
Options: 'INFO'=0, 'MINOR'=1, 'MAJOR'=2, 'CRITICAL'=3, 'BLOCKER'=4
Set the SEARCH_STRING to this valid regular expression:
(?i:\scursor\s)
Set the MESSAGE for when a match for regular expression <SEARCH_STRING> is found in a Changeset:

Example: Warning! CURSOR detected!
Set STRIP_COMMENTS to true if you want to remove the comments from the output.

The regex custom policy check is created successfully.

Sample Failing Scripts

Copy

--changeset amalik:cursor
DECLARE @name VARCHAR(50) -- database name 
DECLARE @path VARCHAR(256) -- path for backup files 
DECLARE @fileName VARCHAR(256) -- filename for backup 
DECLARE @fileDate VARCHAR(20) -- used for file name 

SET @path = 'C:\Backup\' 

SELECT @fileDate = CONVERT(VARCHAR(20),GETDATE(),112) 

DECLARE db_cursor CURSOR FOR 
SELECT name 
FROM MASTER.dbo.sysdatabases 
WHERE name NOT IN ('master','model','msdb','tempdb') 

OPEN db_cursor  
FETCH NEXT FROM db_cursor INTO @name  

WHILE @@FETCH_STATUS = 0  
BEGIN  
      SET @fileName = @path + @name + '_' + @fileDate + '.BAK' 
      BACKUP DATABASE @name TO DISK = @fileName 

      FETCH NEXT FROM db_cursor INTO @name 
END 

CLOSE db_cursor  
DEALLOCATE db_cursor

Sample Error Message

Copy

CHANGELOG CHECKS
----------------
Checks completed validation of the changelog and found the following issues:

Check Name:         Check for specific patterns in sql (NoCursor)
Changeset ID:       cursor
Changeset Filepath: changeLogs/2_objects/02_storedprocedure/cursor.sql
Check Severity:     INFO (Return code: 0)
Message:            Warning! CURSOR detected!