Change: ‘sqlFile’

The ‘sqlFile’ tag allows you to specify any sql statements and have it stored external in a file. It is useful for complex changes that are not supported through LiquiBase’s automated refactoring tags such as stored procedures.

The sqlFile refactoring finds the file by searching in the following order:

The file is searched for in the classpath. This can be manually set and by default the liquibase startup script adds the current directory when run. The file is searched for using the file attribute as a file name. This allows absolute paths to be used or relative paths to the working directory to be used. The ‘sqlFile’ tag can also support multiline 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.Multiline 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 file can also contain comments of either of the following formats:

A multiline comment that starts with /* and ends with */. A single line comment starting with <space>–<space> and finishing at the end of the line

Available Attributes

NameDescriptionRequired ForSupportsSince
dbmsall3.0
encodingall
endDelimiterDelimiter to apply to the end of the statement. Defaults to ';', may be set to ''.all
pathThe file path of the SQL file to loadallall
relativeToChangelogFileall
splitStatementsSet to false to not have liquibase split statements on ;'s and GO's. Defaults to true if not setall
stripCommentsSet to true to remove any comments in the SQL before executing, otherwise false. Defaults to false if not setall
<changeSet author="liquibase-docs" id="sqlFile-example">
    <sqlFile dbms="h2, oracle"
            encoding="utf8"
            endDelimiter="\nGO"
            path="my/path/file.sql"
            relativeToChangelogFile="true"
            splitStatements="true"
            stripComments="true"/>
</changeSet>
changeSet:
  id: sqlFile-example
  author: liquibase-docs
  changes:
  - sqlFile:
      dbms: h2, oracle
      encoding: utf8
      endDelimiter: \nGO
      path: my/path/file.sql
      relativeToChangelogFile: true
      splitStatements: true
      stripComments: true
{
  "changeSet": {
    "id": "sqlFile-example",
    "author": "liquibase-docs",
    "changes": [
      {
        "sqlFile": {
          "dbms": "h2, oracle",
          "encoding": "utf8",
          "endDelimiter": "\\nGO",
          "path": "my/path/file.sql",
          "relativeToChangelogFile": true,
          "splitStatements": true,
          "stripComments": true
        }
      }]
    
  }
}

SQL Generated From Above Sample (MySQL)

Database Support

DatabaseNotesAuto Rollback
DB2SupportedNo
DerbySupportedNo
FirebirdSupportedNo
H2SupportedNo
HyperSQLSupportedNo
InformixSupportedNo
MySQLSupportedNo
OracleSupportedNo
PostgreSQLSupportedNo
SQL ServerSupportedNo
SQLiteSupportedNo
SybaseSupportedNo
Sybase AnywhereSupportedNo

Missing, incomplete or wrong information? Please send a pull request