liquibase.change.core

Class SQLFileChange

java.lang.Object

liquibase.change.AbstractChange

liquibase.change.AbstractSQLChange

liquibase.change.core.SQLFileChange

All Implemented Interfaces:

Change, DbmsTargetedChange, LiquibaseSerializable

public class SQLFileChange
extends AbstractSQLChange

Represents a Change for custom SQL stored in a File.

To create an instance call the constructor as normal and then call AbstractChange.setResourceAccessor(ResourceAccessor) before calling setPath, otherwise the file will likely not be found.

Nested Class Summary

Nested classes/interfaces inherited from class liquibase.change.AbstractSQLChange

AbstractSQLChange.NormalizingStream

Nested classes/interfaces inherited from interface liquibase.serializer.LiquibaseSerializable

LiquibaseSerializable.SerializationType

Field Summary

Fields inherited from class liquibase.change.AbstractSQLChange

encoding

Fields inherited from class liquibase.change.AbstractChange

NODENAME_COLUMN

Fields inherited from interface liquibase.serializer.LiquibaseSerializable

GENERIC_CHANGELOG_EXTENSION_NAMESPACE, GENERIC_SNAPSHOT_EXTENSION_NAMESPACE, STANDARD_CHANGELOG_NAMESPACE, STANDARD_SNAPSHOT_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
SQLFileChange()

Method Summary

Methods

Modifier and Type	Method and Description
void	finishInitialization() Default implementation is a no-op
boolean	generateRollbackStatementsVolatile(Database database) Implementation delegates logic to the SqlGenerator.generateRollbackStatementsIsVolatile(Database) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database) If no or null SqlStatements are returned by generateRollbackStatements then this method returns false.
boolean	generateStatementsVolatile(Database database) Implementation delegates logic to the SqlGenerator.generateStatementsIsVolatile(Database) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database).
String	getConfirmationMessage() Confirmation message to be displayed after the change is executed.
String	getEncoding() The encoding of the file containing SQL statements
String	getPath()
String	getSerializedObjectNamespace()
String	getSql() Return the raw SQL managed by this Change
Boolean	isRelativeToChangelogFile()
InputStream	openSqlStream()
void	setEncoding(String encoding)
void	setPath(String fileName) Sets the file name but setUp must be called for the change to have impact.
void	setRelativeToChangelogFile(Boolean relativeToChangelogFile)
void	setSql(String sql) Set the raw SQL managed by this Change.
ValidationErrors	validate(Database database) Implementation checks the ChangeParameterMetaData for declared required fields and also delegates logic to the SqlGenerator.validate(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database).

Methods inherited from class liquibase.change.AbstractSQLChange

checkStatus, generateCheckSum, generateStatements, getDbms, getEndDelimiter, isSplitStatements, isStripComments, normalizeLineEndings, setDbms, setEndDelimiter, setSplitStatements, setStripComments, supports, warn

Methods inherited from class liquibase.change.AbstractChange

createChangeMetaData, createChangeParameterMetadata, createDescriptionMetaData, createEmptyColumnConfig, createExampleValueMetaData, createInverses, createMustEqualExistingMetaData, createRequiredDatabasesMetaData, createSerializationTypeMetaData, createSinceMetaData, createSupportedDatabasesMetaData, customLoadLogic, generateRollbackStatements, getAffectedDatabaseObjects, getChangeSet, getDescription, getResourceAccessor, getSerializableFieldNamespace, getSerializableFields, getSerializableFieldType, getSerializableFieldValue, getSerializedObjectName, isInvalidProperty, load, serialize, serializeValue, setChangeSet, setResourceAccessor, supportsRollback, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SQLFileChange

public SQLFileChange()

Method Detail

generateStatementsVolatile

public boolean generateStatementsVolatile(Database database)

Description copied from class: AbstractChange

Implementation delegates logic to the SqlGenerator.generateStatementsIsVolatile(Database) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database). If zero or null SqlStatements are returned by generateStatements then this method returns false.

Specified by:

generateStatementsVolatile in interface Change

Overrides:

generateStatementsVolatile in class AbstractSQLChange

generateRollbackStatementsVolatile

public boolean generateRollbackStatementsVolatile(Database database)

Description copied from class: AbstractChange

Implementation delegates logic to the SqlGenerator.generateRollbackStatementsIsVolatile(Database) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database) If no or null SqlStatements are returned by generateRollbackStatements then this method returns false.

Specified by:

generateRollbackStatementsVolatile in interface Change

Overrides:

generateRollbackStatementsVolatile in class AbstractSQLChange

getPath

public String getPath()

setPath

public void setPath(String fileName)

Sets the file name but setUp must be called for the change to have impact.

Parameters:

fileName - The file to use

getEncoding

public String getEncoding()

The encoding of the file containing SQL statements

Returns:

the encoding

setEncoding

public void setEncoding(String encoding)

Parameters:

encoding - the encoding to set

isRelativeToChangelogFile

public Boolean isRelativeToChangelogFile()

setRelativeToChangelogFile

public void setRelativeToChangelogFile(Boolean relativeToChangelogFile)

finishInitialization

public void finishInitialization()
                          throws SetupException

Description copied from class: AbstractChange

Default implementation is a no-op

Specified by:

finishInitialization in interface Change

Overrides:

finishInitialization in class AbstractChange

Throws:

SetupException

openSqlStream

public InputStream openSqlStream()
                          throws IOException

Overrides:

openSqlStream in class AbstractSQLChange

Throws:

IOException

validate

public ValidationErrors validate(Database database)

Description copied from class: AbstractChange

Implementation checks the ChangeParameterMetaData for declared required fields and also delegates logic to the SqlGenerator.validate(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database). If no or null SqlStatements are returned by generateStatements then this method returns no errors. If there are no parameters than this method returns no errors

Specified by:

validate in interface Change

Overrides:

validate in class AbstractSQLChange

getConfirmationMessage

public String getConfirmationMessage()

Description copied from interface: Change

Confirmation message to be displayed after the change is executed. Should include relevant configuration settings to make it as helpful as possible. This method may be called outside the changelog execution process, such as in documentation generation.

getSql

public String getSql()

Description copied from class: AbstractSQLChange

Return the raw SQL managed by this Change

Overrides:

getSql in class AbstractSQLChange

setSql

public void setSql(String sql)

Description copied from class: AbstractSQLChange

Set the raw SQL managed by this Change. The passed sql is trimmed and set to null if an empty string is passed.

Overrides:

setSql in class AbstractSQLChange

getSerializedObjectNamespace

public String getSerializedObjectNamespace()

Specified by:

getSerializedObjectNamespace in interface LiquibaseSerializable

Overrides:

getSerializedObjectNamespace in class AbstractChange