liquibase.change.core

Class CreateProcedureChange

java.lang.Object

liquibase.change.AbstractChange

liquibase.change.core.CreateProcedureChange

All Implemented Interfaces:

Change, DbmsTargetedChange, LiquibaseSerializable

public class CreateProcedureChange
extends AbstractChange
implements DbmsTargetedChange

Nested Class Summary

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

LiquibaseSerializable.SerializationType

Field Summary

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
CreateProcedureChange()

Method Summary

Methods

Modifier and Type	Method and Description
CheckSum	generateCheckSum() Calculates the checksum based on the contained SQL.
SqlStatement[]	generateStatements(Database database) Generates the SqlStatement objects required to run the change for the given database.
protected SqlStatement[]	generateStatements(java.lang.String logicText, java.lang.String endDelimiter, Database database)
java.lang.String	getCatalogName()
java.lang.String	getComments()
java.lang.String	getConfirmationMessage() Confirmation message to be displayed after the change is executed.
java.lang.String	getDbms()
java.lang.String	getEncoding()
java.lang.String	getPath()
java.lang.String	getProcedureName()
java.lang.String	getProcedureText()
java.lang.String	getSchemaName()
java.lang.String	getSerializedObjectNamespace()
java.lang.Boolean	isRelativeToChangelogFile()
java.io.InputStream	openSqlStream()
void	setCatalogName(java.lang.String catalogName)
void	setComments(java.lang.String comments)
void	setDbms(java.lang.String dbms)
void	setEncoding(java.lang.String encoding)
void	setPath(java.lang.String path)
void	setProcedureName(java.lang.String procedureName)
void	setProcedureText(java.lang.String procedureText)
void	setRelativeToChangelogFile(java.lang.Boolean relativeToChangelogFile)
void	setSchemaName(java.lang.String schemaName)
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.AbstractChange

createChangeMetaData, createChangeParameterMetadata, createDescriptionMetaData, createExampleValueMetaData, createInverses, createMustEqualExistingMetaData, createRequiredDatabasesMetaData, createSerializationTypeMetaData, createSinceMetaData, createSupportedDatabasesMetaData, finishInitialization, generateRollbackStatements, generateRollbackStatementsVolatile, generateStatementsVolatile, getAffectedDatabaseObjects, getChangeSet, getResourceAccessor, getSerializableFields, getSerializableFieldType, getSerializableFieldValue, getSerializedObjectName, setChangeSet, setResourceAccessor, supports, supportsRollback, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateProcedureChange

public CreateProcedureChange()

Method Detail

getCatalogName

public java.lang.String getCatalogName()

setCatalogName

public void setCatalogName(java.lang.String catalogName)

getSchemaName

public java.lang.String getSchemaName()

setSchemaName

public void setSchemaName(java.lang.String schemaName)

getProcedureName

public java.lang.String getProcedureName()

setProcedureName

public void setProcedureName(java.lang.String procedureName)

getEncoding

public java.lang.String getEncoding()

setEncoding

public void setEncoding(java.lang.String encoding)

getPath

public java.lang.String getPath()

setPath

public void setPath(java.lang.String path)

isRelativeToChangelogFile

public java.lang.Boolean isRelativeToChangelogFile()

setRelativeToChangelogFile

public void setRelativeToChangelogFile(java.lang.Boolean relativeToChangelogFile)

getProcedureText

public java.lang.String getProcedureText()

setProcedureText

public void setProcedureText(java.lang.String procedureText)

getDbms

public java.lang.String getDbms()

Specified by:

getDbms in interface DbmsTargetedChange

Returns:

A comma separated list of dbms' that this change will be run for. Will run for all dbms' if empty or null.

setDbms

public void setDbms(java.lang.String dbms)

Specified by:

setDbms in interface DbmsTargetedChange

getComments

public java.lang.String getComments()

setComments

public void setComments(java.lang.String comments)

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 AbstractChange

openSqlStream

public java.io.InputStream openSqlStream()
                                  throws java.io.IOException

Throws:

java.io.IOException

generateCheckSum

public CheckSum generateCheckSum()

Calculates the checksum based on the contained SQL.

Specified by:

generateCheckSum in interface Change

Overrides:

generateCheckSum in class AbstractChange

See Also:

AbstractChange.generateCheckSum()

generateStatements

public SqlStatement[] generateStatements(Database database)

Description copied from interface: Change

Generates the SqlStatement objects required to run the change for the given database.

NOTE: This method may be called multiple times throughout the changelog execution process and may be called in documentation generation and other integration points as well.

If this method reads from the current database state or uses any other logic that will be affected by whether previous changeSets have ran or not, you must return true from Change.generateStatementsVolatile(liquibase.database.Database).

Specified by:

generateStatements in interface Change

generateStatements

protected SqlStatement[] generateStatements(java.lang.String logicText,
                                java.lang.String endDelimiter,
                                Database database)

getConfirmationMessage

public java.lang.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.

Specified by:

getConfirmationMessage in interface Change

getSerializedObjectNamespace

public java.lang.String getSerializedObjectNamespace()

Specified by:

getSerializedObjectNamespace in interface LiquibaseSerializable

Overrides:

getSerializedObjectNamespace in class AbstractChange