sql

The <SQL> Change Type allows you to specify whatever SQL you want.

Uses

It is useful for complex changes that aren't supported through Liquibase's automated Change Types and to work around bugs and limitations of Liquibase. The SQL contained in the <SQL> Change Type can be multi-line.

Tip: If you use psql, SQL Plus, or sqlcmd utility and Liquibase Pro, see Using the PSQL integration and runWith attribute with Liquibase Pro and PostgreSQL, Using the SQL Plus integration and runWith attribute with Liquibase Pro and Oracle, and Using the SQLCMD integration and runWith attribute with Liquibase Pro and MSSQL Server.

Using the SQL Change Type

The <SQL> Change Type can also support multi-line statements in the same file. Statements can either be split using a ; at the end of the last line of the SQL or a GO on its own on the line between the statements can be used. Multi-line SQL statements are also supported and only a ; or GO statement will finish a statement, a new line is not enough. Files containing a single statement do not need to use a ; or GO.

The SQL change can also contain comments of either of the following formats:

A multi-line comment that starts with /* and ends with */.
A single line comment starting with -- and finishing at the end of the line.

Note: By default it will attempt to split statements on a ; or GO at the end of lines. Because of this, if you have a comment or some other non-statement ending ; or GO, don't have it at the end of a line or you will get invalid SQL.

XML Example

<changeSet  author="liquibase-docs"  id="sql-example">
  <sql dbms="!h2, oracle, mysql"
   endDelimiter="\nGO"
   splitStatements="true"
   stripComments="true">insert into person (name) values ('Bob')
   
<comment>What about Bob?</comment>
   </sql>
</changeSet>

YAML Example

changeSet:  
   id:  sql-example  
   author:  liquibase-docs  
   changes:  
    -  sql:  
    	dbms:  '!h2,  oracle,  mysql'  
    	endDelimiter:  \nGO  
   		splitStatements:  true  
    	sql:  insert into person (name) values ('Bob')  
    	stripComments:  true
   comment:  What about Bob?

JSON Example

{ 
	"databaseChangeLog": [
		{
			"changeSet": {
				"id": "sql-example",
				"author": "liquibase-docs",
				"changes": [
				{
					"sql": {
						"dbms": "!h2, oracle, mysql",
						"endDelimiter": "GO",
						"splitStatements": true,
						"sql": "insert into person (name) values ('Bob')",
						"stripComments": true
					}
				},
				"comment": "What about Bob?",
			]
		}
	}
]}

Available attributes

Name	Description	Required for	Supports	Since
`dbms`	Specifies which database types the change must be applied to. Valid database type names are listed on the supported databases page. Separate multiple databases with commas. Specify that a change does not apply to a database type by prefixing it with `!`. The keywords `all` and `none` are also available.		all	3.0
`endDelimiter`	Specifies what character ends a SQL statement. Can be used to override the default value of `;`. For example, a stored function that contains the default `;` end delimiter to separate the statements inside the function. For more information, see endDelimiter SQL attribute.		all
`splitStatements`	Set to false to not have Liquibase split statements on ;'s and GO's. Defaults to true if not set		all
`sql`	Specifies the SQL to execute	all	all
`stripComments`	Set to true to remove any comments in the SQL before executing, otherwise false.		all

Database support

Database	Notes	Auto Rollback
DB2/LUW	Supported	No
DB2/z	Supported	No
Derby	Supported	No
Firebird	Supported	No
H2	Supported	No
HyperSQL	Supported	No
INGRES	Supported	No
Informix	Supported	No
MariaDB	Supported	No
MySQL	Supported	No
Oracle	Supported	No
PostgreSQL	Supported	No
Snowflake	Supported	No
SQL Server	Supported	No
SQLite	Supported	No
Sybase	Supported	No
Sybase Anywhere	Supported	No