liquibase.change.custom
Interface CustomSqlChange

All Superinterfaces:

CustomChange

public interface CustomSqlChange
extends CustomChange

Interface to implement when creating a custom change that generates SQL. When updating a database, implementing this interface is preferred over CustomTaskChange because the SQL can either be executed directly or saved to a text file for later use depending on the migration mode used. To allow the change to be rolled back, also implement the CustomSqlRollback interface. If your change requires sql-based logic and non-sql-based logic, it is best to create a change set that contains a mix of CustomSqlChange and CustomTaskChange calls.

See Also:

CustomSqlRollback, CustomTaskChange

Method Summary

SqlStatement[]

generateStatements(Database database) Generates the SQL statements required to run the change

Methods inherited from interface liquibase.change.custom.CustomChange

getConfirmationMessage, setFileOpener, setUp, validate

Method Detail

generateStatements

SqlStatement[] generateStatements(Database database)
                                  throws CustomChangeException

Generates the SQL statements required to run the change

Parameters:

database - the target Database associated to this change's statements

Returns:

an array of SqlStatements with the statements

Throws:

CustomChangeException - if an exception occurs while processing this change

UnsupportedChangeException - if this change is not supported by the Database passed as argument