As of Liquibase 2.0, Liquibase includes support for “plain SQL” changelog files. These changelogs may be included from XML changelogs and may contain arbitrary SQL statements. The statements are converted to custom_sql refactorings.
Formatted SQL files use comments to provide Liquibase with metadata. Each SQL file must begin with the following comment:
Each changeset in a formatted SQL file begins with a comment of the form
The changeset comment is followed by one or more SQL statements, separated by
semicolons (or the value of the
The following attributes may be provided on each changeset:
|stripComments||Set to true to remove any comments in the SQL before executing, otherwise false. Defaults to true if not set|
|splitStatements||Set to false to not have liquibase split statements on ;'s and GO's. Defaults to true if not set|
|rollbackSplitStatements||Same as splitStatements but for rollback SQL|
|endDelimiter||Delimiter to apply to the end of the statement. Defaults to ";", may be set to "".|
|rollbackEndDelimiter||Same as endDelimiter but for rollback SQL|
|runAlways||Executes the change set on every run, even if it has been run before|
|runOnChange||Executes the change the first time it is seen and each time the change set has been changed|
|context||Executes the change if the particular context was passed at runtime. Any string can be used for the context name and they are checked case-insensitively.|
|logicalFilePath||Use to override the file name and path when creating the unique identifier of change sets. Required when moving or renaming change logs.|
|labels||Labels are general purpose way to categorize changeSets like contexts, but working in the opposite way. Instead of defining a set of contexts at runtime and then a match expression in the changeSet, you define a set of labels in the context and a match expression at runtime.|
|runInTransaction||Should the changeSet be ran as a single transaction (if possible)? Defaults to true. Warning: be careful with this attribute. If set to false and an error occurs part way through running a changeSet containing multiple statements, the Liquibase databasechangelog table will be left in an invalid state|
|failOnError||Should the migration fail if an error occurs while executing the changeSet?|
|dbms||The type of a database which that changeSet is to be used for. When the migration step is running, it checks the database type against this
attribute. Valid database type names are listed on the supported databases page. It is possible to list multiple databases separated by commas.
You can also specify that a changeset is NOT applicable to a particular database type by prefixing with |
!. The keywords
noneare also available.
|logicalFilePath||Sets a logical file path in databasechangelog table instead of physical file location of sql where the liquibase executed.|
Preconditions can be specified for each changeset. Currently, only the SQL Check precondition is supported.
Changesets may include statements to be applied when rolling back the changeset. Rollback statements are comments of the form
A description of the change set. Future releases of Liquibase may be able to make use of comments to generate documentation.
Checksum which are considered valid for this changeSet, regardless of what is stored in the database. Used primarily when you need to change a changeSet and don’t want errors thrown on databases on which it has already run (not a recommended procedure).Since 3.5
Allow to ignore some lines. Useful when using same script with other SQL tool. Since 3.7
Mark two lines to be ignored:
Same effect using start-end syntax: