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 Use PSQL and runWith on PostgreSQL, Use SQL Plus and runWith on Oracle Database, and Use SQLCMD and runWith on Microsoft SQL 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.

Currently, there is no SQL example for the <sql> tag, since you can just put SQL into a SQL formatted changelog.

...
<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>
...
...
-  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?
...
...
{ 
	"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 type(s) a changeset is to be used for. See valid database type names on Liquibase Database Tutorials. Separate multiple databases with commas. Specify that a changeset is not applicable to a particular database type by prefixing with !. The keywords all and none are also available.

 all 3.0
endDelimiter

Specifies delimiter to apply to the end of the statement. Your delimiter string can be a combination of one or more letters, symbols, and/or numbers, or the empty string (""). Default: ";".

 all
splitStatements

Removes Liquibase split statements on ;'s and GO's when it is set to false. Default: true.

 all
sql Specifies the SQL to execute all all
stripComments

Removes any comments in the SQL before executing when it is set to true. Otherwise, set it to false. Default: true.

 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

Related links