Liquibase 4.26.0 · liquibase.change.custom.CustomChangeWrapper

public Class CustomChangeWrapper

Class Inheritance

java.lang.Object
liquibase.AbstractExtensibleObject
liquibase.plugin.AbstractPlugin
liquibase.change.AbstractChange
liquibase.change.custom.CustomChangeWrapper

Annotations

@DatabaseChange
name:customChange
description:Although Liquibase tries to provide a wide range of database refactorings, there are times you may want to create your own custom refactoring class. To create your own custom refactoring, simply create a class that implements the liquibase.change.custom.CustomSqlChange or liquibase.change.custom.CustomTaskChange interface and use the tag in your changeset. If your change can be rolled back, implement the liquibase.change.custom.CustomSqlRollback interface as well. For a sample custom change class, see liquibase.change.custom.ExampleCustomSqlChange
priority:1

Imports

liquibase.Scope, liquibase.change.*, liquibase.database.Database, liquibase.exception.*, liquibase.parser.core.ParsedNode, .ParsedNodeException, liquibase.resource.ResourceAccessor, liquibase.statement.SqlStatement, liquibase.util.ObjectUtil, .OsgiUtil, java.util.*

Adapts CustomChange implementations to the standard change system used by Liquibase. Custom change implementations should implement CustomSqlChange or CustomTaskChange

Modifier and Type	Field and Description
private String	className
private boolean	configured
pack-priv CustomChange	customChange Non-private access only for testing.
private final SortedSet<String>	params
private final Map<String, String>	paramValues

Modifier and Type

Field and Description

private String

className

private boolean

configured

pack-priv CustomChange

customChange

Non-private access only for testing.

private final SortedSet<String>

params

private final Map<String, String>

paramValues

Constructor Summary

Access	Constructor and Description
public	CustomChangeWrapper()

Modifier and Type	Method and Description
private void	configureCustomChange()
public void	customLoadLogic(ParsedNode parsedNode, ResourceAccessor resourceAccessor) Overrides liquibase.change.AbstractChange.customLoadLogic.
public SqlStatement[]	generateRollbackStatements(Database database) Overrides liquibase.change.AbstractChange.generateRollbackStatements. Implements liquibase.change.Change.generateRollbackStatements. Finishes configuring the CustomChange based on the values passed to `setParam(String, String)` then calls `CustomSqlRollback#generateRollbackStatements(liquibase.database.Database)` or `CustomTaskRollback#rollback(liquibase.database.Database)` depending on the CustomChange implementation.
public SqlStatement[]	generateStatements(Database database) Implements liquibase.change.Change.generateStatements. Finishes configuring the CustomChange based on the values passed to `setParam(String, String)` then calls `CustomSqlChange#generateStatements(liquibase.database.Database)` or `CustomTaskChange#execute(liquibase.database.Database)` depending on the CustomChange implementation.
public boolean	generateStatementsVolatile(Database database) Overrides liquibase.change.AbstractChange.generateStatementsVolatile. Implements liquibase.change.Change.generateStatementsVolatile. Implementation delegates logic to the `liquibase.sqlgenerator.SqlGenerator#generateStatementsIsVolatile(Database)` method on the `SqlStatement` objects returned by `generateStatements`.
public String	getClassName() Returns the name of the custom class set in `setClass(String)`
public String	getConfirmationMessage() Implements liquibase.change.Change.getConfirmationMessage. Return the customChange's `CustomChange#getConfirmationMessage` message as the Change's message.
public CustomChange	getCustomChange() Return the CustomChange instance created by the call to `setClass(String)`.
public SortedSet<String>	getParams() Returns the parameters set by `setParam(String, String)`.
public String	getParamValue(String key) Get the value of a parameter set by `setParam(String, String)`.
public Set<String>	getSerializableFields() Overrides liquibase.change.AbstractChange.getSerializableFields. Implements liquibase.serializer.LiquibaseSerializable.getSerializableFields. Returns the fields on this change that are serializable.
public LiquibaseSerializable.SerializationType	getSerializableFieldType(String field) Overrides liquibase.change.AbstractChange.getSerializableFieldType. Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldType.
public Object	getSerializableFieldValue(String field) Overrides liquibase.change.AbstractChange.getSerializableFieldValue. Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldValue.
public String	getSerializedObjectNamespace() Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace. Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.
public void	load(ParsedNode parsedNode, ResourceAccessor resourceAccessor) Overrides liquibase.change.AbstractChange.load. Implements liquibase.serializer.LiquibaseSerializable.load.
public CustomChangeWrapper	setClass(String className) Specify the name of the class to use as the CustomChange and assigns it to `getCustomChange()`.
public void	setParam(String name, String value) Specify a parameter on the CustomChange object to set before executing `liquibase.change.Change#generateStatements(liquibase.database.Database)` or `generateRollbackStatements(liquibase.database.Database)` on it.
public boolean	supportsRollback(Database database) Overrides liquibase.change.AbstractChange.supportsRollback. Implements liquibase.change.Change.supportsRollback. Returns true if the customChange supports rolling back.
public ValidationErrors	validate(Database database) Overrides liquibase.change.AbstractChange.validate. Implements liquibase.change.Change.validate. Call the `CustomChange#validate(liquibase.database.Database)` method and return the result.
public Warnings	warn(Database database) Overrides liquibase.change.AbstractChange.warn. Implements liquibase.change.Change.warn. Required for the Change interface, but not supported by CustomChanges.

Modifier and Type

Method and Description

private void

configureCustomChange()

public void

customLoadLogic(ParsedNode parsedNode, ResourceAccessor resourceAccessor)

Overrides liquibase.change.AbstractChange.customLoadLogic.

public SqlStatement[]

generateRollbackStatements(Database database)

Overrides liquibase.change.AbstractChange.generateRollbackStatements.

Implements liquibase.change.Change.generateRollbackStatements.

Finishes configuring the CustomChange based on the values passed to setParam(String, String) then calls CustomSqlRollback#generateRollbackStatements(liquibase.database.Database) or CustomTaskRollback#rollback(liquibase.database.Database) depending on the CustomChange implementation.

public SqlStatement[]

generateStatements(Database database)

Implements liquibase.change.Change.generateStatements.

Finishes configuring the CustomChange based on the values passed to setParam(String, String) then calls CustomSqlChange#generateStatements(liquibase.database.Database) or CustomTaskChange#execute(liquibase.database.Database) depending on the CustomChange implementation.

public boolean

generateStatementsVolatile(Database database)

Overrides liquibase.change.AbstractChange.generateStatementsVolatile.

Implements liquibase.change.Change.generateStatementsVolatile.

Implementation delegates logic to the liquibase.sqlgenerator.SqlGenerator#generateStatementsIsVolatile(Database) method on the SqlStatement objects returned by generateStatements.

public String

getClassName()

Returns the name of the custom class set in setClass(String)

public String

getConfirmationMessage()

Implements liquibase.change.Change.getConfirmationMessage.

Return the customChange's CustomChange#getConfirmationMessage message as the Change's message.

public CustomChange

getCustomChange()

Return the CustomChange instance created by the call to setClass(String).

public SortedSet<String>

getParams()

Returns the parameters set by setParam(String, String).

public String

getParamValue(String key)

Get the value of a parameter set by setParam(String, String).

public Set<String>

getSerializableFields()

Overrides liquibase.change.AbstractChange.getSerializableFields.

Implements liquibase.serializer.LiquibaseSerializable.getSerializableFields.

Returns the fields on this change that are serializable.

public LiquibaseSerializable.SerializationType

getSerializableFieldType(String field)

Overrides liquibase.change.AbstractChange.getSerializableFieldType.

Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldType.

public Object

getSerializableFieldValue(String field)

Overrides liquibase.change.AbstractChange.getSerializableFieldValue.

Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldValue.

public String

getSerializedObjectNamespace()

Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace.

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.

public void

load(ParsedNode parsedNode, ResourceAccessor resourceAccessor)

Overrides liquibase.change.AbstractChange.load.

Implements liquibase.serializer.LiquibaseSerializable.load.

public CustomChangeWrapper

setClass(String className)

Specify the name of the class to use as the CustomChange and assigns it to getCustomChange().

public void

setParam(String name, String value)

public boolean

supportsRollback(Database database)

Overrides liquibase.change.AbstractChange.supportsRollback.

Implements liquibase.change.Change.supportsRollback.

Returns true if the customChange supports rolling back.

public ValidationErrors

validate(Database database)

Overrides liquibase.change.AbstractChange.validate.

Implements liquibase.change.Change.validate.

Call the CustomChange#validate(liquibase.database.Database) method and return the result.

public Warnings

warn(Database database)

Overrides liquibase.change.AbstractChange.warn.

Implements liquibase.change.Change.warn.

Required for the Change interface, but not supported by CustomChanges.

Field Detail

className	back to summary
private String className

configured	back to summary
private boolean configured

customChange	back to summary
pack-priv CustomChange customChange Non-private access only for testing.

params	back to summary
private final SortedSet<String> params

paramValues	back to summary
private final Map<String, String> paramValues

Constructor Detail

CustomChangeWrapper	back to summary
public CustomChangeWrapper()

Method Detail

configureCustomChange	back to summary
private void configureCustomChange() throws CustomChangeException

customLoadLogic	back to summary
public void customLoadLogic(ParsedNode parsedNode, ResourceAccessor resourceAccessor) throws ParsedNodeException Overrides liquibase.change.AbstractChange.customLoadLogic. Annotations @Override

customLoadLogic

back to summary

public void customLoadLogic(ParsedNode parsedNode, ResourceAccessor resourceAccessor) throws ParsedNodeException

Overrides liquibase.change.AbstractChange.customLoadLogic.

Annotations

@Override

generateRollbackStatements back to summary

generateRollbackStatements	back to summary
public SqlStatement[] generateRollbackStatements(Database database) throws RollbackImpossibleException Overrides liquibase.change.AbstractChange.generateRollbackStatements. Implements liquibase.change.Change.generateRollbackStatements. Finishes configuring the CustomChange based on the values passed to `setParam(String, String)` then calls `CustomSqlRollback#generateRollbackStatements(liquibase.database.Database)` or `CustomTaskRollback#rollback(liquibase.database.Database)` depending on the CustomChange implementation. If the CustomChange returns a null SqlStatement array, this method returns an empty array. If a CustomTaskChange is being used, this method will return an empty array. Any `RollbackImpossibleException` exceptions thrown by the CustomChange will thrown by this method. Annotations @Override Exceptions RollbackImpossibleException: Doc from liquibase.change.Change.generateRollbackStatements. if rollback is not supported for this change

public SqlStatement[] generateRollbackStatements(Database database) throws RollbackImpossibleException

Overrides liquibase.change.AbstractChange.generateRollbackStatements.

Implements liquibase.change.Change.generateRollbackStatements.

If the CustomChange returns a null SqlStatement array, this method returns an empty array. If a CustomTaskChange is being used, this method will return an empty array. Any RollbackImpossibleException exceptions thrown by the CustomChange will thrown by this method.

Annotations

@Override

Exceptions

RollbackImpossibleException:

Doc from liquibase.change.Change.generateRollbackStatements.

if rollback is not supported for this change

generateStatements back to summary

generateStatements	back to summary
public SqlStatement[] generateStatements(Database database) Implements liquibase.change.Change.generateStatements. Finishes configuring the CustomChange based on the values passed to `setParam(String, String)` then calls `CustomSqlChange#generateStatements(liquibase.database.Database)` or `CustomTaskChange#execute(liquibase.database.Database)` depending on the CustomChange implementation. If the CustomChange returns a null SqlStatement array, this method returns an empty array. If a CustomTaskChange is being used, this method will return an empty array. Annotations @Override

public SqlStatement[] generateStatements(Database database)

Implements liquibase.change.Change.generateStatements.

If the CustomChange returns a null SqlStatement array, this method returns an empty array. If a CustomTaskChange is being used, this method will return an empty array.

Annotations

@Override

generateStatementsVolatile back to summary

generateStatementsVolatile	back to summary
public boolean generateStatementsVolatile(Database database) Overrides liquibase.change.AbstractChange.generateStatementsVolatile. Implements liquibase.change.Change.generateStatementsVolatile. Doc from liquibase.change.AbstractChange.generateStatementsVolatile. Implementation delegates logic to the `liquibase.sqlgenerator.SqlGenerator#generateStatementsIsVolatile(Database)` method on the `SqlStatement` objects returned by `generateStatements`. If zero or null SqlStatements are returned by generateStatements then this method returns false. Annotations @Override

public boolean generateStatementsVolatile(Database database)

Overrides liquibase.change.AbstractChange.generateStatementsVolatile.

Implements liquibase.change.Change.generateStatementsVolatile.

Doc from liquibase.change.AbstractChange.generateStatementsVolatile.

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

Annotations

@Override

getClassName back to summary

getClassName	back to summary
public String getClassName() Returns the name of the custom class set in `setClass(String)` Annotations @DatabaseChangeProperty description:Name class that implements the custom change.

public String getClassName()

Returns the name of the custom class set in setClass(String)

Annotations

@DatabaseChangeProperty
description:Name class that implements the custom change.

getConfirmationMessage back to summary

getConfirmationMessage	back to summary
public String getConfirmationMessage() Implements liquibase.change.Change.getConfirmationMessage. Return the customChange's `CustomChange#getConfirmationMessage` message as the Change's message. Annotations @Override

public String getConfirmationMessage()

Implements liquibase.change.Change.getConfirmationMessage.

Return the customChange's CustomChange#getConfirmationMessage message as the Change's message.

Annotations

@Override

getCustomChange back to summary

getCustomChange	back to summary
public CustomChange getCustomChange() Return the CustomChange instance created by the call to `setClass(String)`. Annotations @DatabaseChangeProperty isChangeProperty:false

public CustomChange getCustomChange()

Return the CustomChange instance created by the call to setClass(String).

Annotations

@DatabaseChangeProperty
isChangeProperty:false

getParams back to summary

getParams	back to summary
public SortedSet<String> getParams() Returns the parameters set by `setParam(String, String)`. If no parameters are set, an empty set will be returned Annotations @DatabaseChangeProperty isChangeProperty:false

public SortedSet<String> getParams()

Returns the parameters set by setParam(String, String). If no parameters are set, an empty set will be returned

Annotations

@DatabaseChangeProperty
isChangeProperty:false

getParamValue	back to summary
public String getParamValue(String key) Get the value of a parameter set by `setParam(String, String)`. If the parameter was not set, null will be returned.

getSerializableFields	back to summary
public Set<String> getSerializableFields() Overrides liquibase.change.AbstractChange.getSerializableFields. Implements liquibase.serializer.LiquibaseSerializable.getSerializableFields. Doc from liquibase.change.AbstractChange.getSerializableFields. Returns the fields on this change that are serializable. Annotations @Override

getSerializableFields

back to summary

public Set<String> getSerializableFields()

Overrides liquibase.change.AbstractChange.getSerializableFields.

Implements liquibase.serializer.LiquibaseSerializable.getSerializableFields.

Doc from liquibase.change.AbstractChange.getSerializableFields.

Returns the fields on this change that are serializable.

Annotations

@Override

getSerializableFieldType	back to summary
public LiquibaseSerializable.SerializationType getSerializableFieldType(String field) Overrides liquibase.change.AbstractChange.getSerializableFieldType. Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldType. Annotations @Override

getSerializableFieldType

back to summary

public LiquibaseSerializable.SerializationType getSerializableFieldType(String field)

Overrides liquibase.change.AbstractChange.getSerializableFieldType.

Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldType.

Annotations

@Override

getSerializableFieldValue	back to summary
public Object getSerializableFieldValue(String field) Overrides liquibase.change.AbstractChange.getSerializableFieldValue. Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldValue. Annotations @Override

getSerializableFieldValue

back to summary

public Object getSerializableFieldValue(String field)

Overrides liquibase.change.AbstractChange.getSerializableFieldValue.

Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldValue.

Annotations

@Override

getSerializedObjectNamespace	back to summary
public String getSerializedObjectNamespace() Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace. Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace. Annotations @Override

getSerializedObjectNamespace

back to summary

public String getSerializedObjectNamespace()

Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace.

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.

Annotations

@Override

load	back to summary
public void load(ParsedNode parsedNode, ResourceAccessor resourceAccessor) throws ParsedNodeException Overrides liquibase.change.AbstractChange.load. Implements liquibase.serializer.LiquibaseSerializable.load. Annotations @Override

load

back to summary

public void load(ParsedNode parsedNode, ResourceAccessor resourceAccessor) throws ParsedNodeException

Overrides liquibase.change.AbstractChange.load.

Implements liquibase.serializer.LiquibaseSerializable.load.

Annotations

@Override

setClass	back to summary
public CustomChangeWrapper setClass(String className) throws CustomChangeException Specify the name of the class to use as the CustomChange and assigns it to `getCustomChange()`.

setParam back to summary

setParam	back to summary
public void setParam(String name, String value) Specify a parameter on the CustomChange object to set before executing `liquibase.change.Change#generateStatements(liquibase.database.Database)` or `generateRollbackStatements(liquibase.database.Database)` on it. The CustomChange class must have a set method for the given parameter. For example, to call setParam("lastName", "X") you must have a method setLastName(String val) on your class.

public void setParam(String name, String value)

Specify a parameter on the CustomChange object to set before executing liquibase.change.Change#generateStatements(liquibase.database.Database) or generateRollbackStatements(liquibase.database.Database) on it. The CustomChange class must have a set method for the given parameter. For example, to call setParam("lastName", "X") you must have a method setLastName(String val) on your class.

supportsRollback back to summary

supportsRollback	back to summary
public boolean supportsRollback(Database database) Overrides liquibase.change.AbstractChange.supportsRollback. Implements liquibase.change.Change.supportsRollback. Returns true if the customChange supports rolling back. `generateRollbackStatements` may still throw a `RollbackImpossibleException` when it is actually executed, even if this method returns true. Currently only checks if the customChange implements `CustomSqlRollback` Annotations @Override

public boolean supportsRollback(Database database)

Overrides liquibase.change.AbstractChange.supportsRollback.

Implements liquibase.change.Change.supportsRollback.

Returns true if the customChange supports rolling back. generateRollbackStatements may still throw a RollbackImpossibleException when it is actually executed, even if this method returns true. Currently only checks if the customChange implements CustomSqlRollback

Annotations

@Override

validate back to summary

validate	back to summary
public ValidationErrors validate(Database database) Overrides liquibase.change.AbstractChange.validate. Implements liquibase.change.Change.validate. Call the `CustomChange#validate(liquibase.database.Database)` method and return the result. Annotations @Override

public ValidationErrors validate(Database database)

Overrides liquibase.change.AbstractChange.validate.

Implements liquibase.change.Change.validate.

Call the CustomChange#validate(liquibase.database.Database) method and return the result.

Annotations

@Override

warn	back to summary
public Warnings warn(Database database) Overrides liquibase.change.AbstractChange.warn. Implements liquibase.change.Change.warn. Required for the Change interface, but not supported by CustomChanges. Returns an empty Warnings object. Annotations @Override

warn

back to summary

public Warnings warn(Database database)

Overrides liquibase.change.AbstractChange.warn.

Implements liquibase.change.Change.warn.

Required for the Change interface, but not supported by CustomChanges. Returns an empty Warnings object.

Annotations

@Override

public Class CustomChangeWrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail