Top Description Fields Methods
liquibase.changeset

public Interface ChangeSetService

extends Plugin
Known Direct Implementers
liquibase.changeset.StandardChangeSetService
Imports
liquibase.change.Change, liquibase.changelog.ChangeSet, .DatabaseChangeLog, .ModifyChangeSets, liquibase.database.ObjectQuotingStrategy, liquibase.parser.core.ParsedNode, .ParsedNodeException, liquibase.plugin.Plugin

The ChangSetService allows for creation and modification of ChangeSets to be pluggable The implemented createChangeSet methods support calls from the Liquibase Core to create Change Sets. Not all ChangeSet constructors are supported at this point. Those constructors will need to be called directly.

Field Summary

Inherited from liquibase.plugin.Plugin:
PRIORITY_DATABASEPRIORITY_DEFAULTPRIORITY_NOT_APPLICABLEPRIORITY_SPECIALIZED

Method Summary

Modifier and TypeMethod and Description
public ChangeSet

Returns:

ChangeSet
createChangeSet
(String id, String author, boolean alwaysRun, boolean runOnChange, String filePath, String contextFilter, String dbmsList, String runWith, String runWithSpoolFile, boolean runInTransaction, ObjectQuotingStrategy quotingStrategy, DatabaseChangeLog databaseChangeLog)

Create a change set with the indicated arguments

public ChangeSet

Returns:

ChangeSet
createChangeSet
(String id, String author, boolean alwaysRun, boolean runOnChange, String filePath, String contextFilter, String dbmsList, DatabaseChangeLog databaseChangeLog)

Create a change set with the indicated arguments

public ChangeSet

Returns:

ChangeSet
createChangeSet
(DatabaseChangeLog
Construct this change set with the DatabaseChangeLog
databaseChangeLog
)

Create a change set with the changelog

public ModifyChangeSets

Returns:

ModifyChangeSets The object which will perform the modifications
createModifyChangeSets
(ParsedNode
The ParsedNode that was created during load
node
)

Create the ModifyChangeSets instance which will do the modifications

public default String

Returns:

null
getEndDelimiter
(ChangeSet
Unused
changeSet
)

Default implementation returns null

public default String

Returns:

String The override setting
getOverrideDelimiter
(String
The endDelimiter to override
endDelimiter
)

Check for an override for a change-level delimiter

public int

Returns:

int
getPriority
()

Return the plugin priority

public void
modifyChangeSets(ChangeSet
The change set to modify
changeSet
,
ModifyChangeSets
The modifier
modifyChangeSets
)

Given a change set and a ModifyChangeSets instance, perform the modifications

Method Detail

createChangeSetback to summary
public ChangeSet createChangeSet(String id, String author, boolean alwaysRun, boolean runOnChange, String filePath, String contextFilter, String dbmsList, String runWith, String runWithSpoolFile, boolean runInTransaction, ObjectQuotingStrategy quotingStrategy, DatabaseChangeLog databaseChangeLog)

Create a change set with the indicated arguments

Returns:ChangeSet

ChangeSet

createChangeSetback to summary
public ChangeSet createChangeSet(String id, String author, boolean alwaysRun, boolean runOnChange, String filePath, String contextFilter, String dbmsList, DatabaseChangeLog databaseChangeLog)

Create a change set with the indicated arguments

Returns:ChangeSet

ChangeSet

createChangeSetback to summary
public ChangeSet createChangeSet(DatabaseChangeLog databaseChangeLog)

Create a change set with the changelog

Parameters
databaseChangeLog:DatabaseChangeLog

Construct this change set with the DatabaseChangeLog

Returns:ChangeSet

ChangeSet

createModifyChangeSetsback to summary
public ModifyChangeSets createModifyChangeSets(ParsedNode node) throws ParsedNodeException

Create the ModifyChangeSets instance which will do the modifications

Parameters
node:ParsedNode

The ParsedNode that was created during load

Returns:ModifyChangeSets

ModifyChangeSets The object which will perform the modifications

Exceptions
ParsedNodeException:
Thrown if unable to access values from the node
getEndDelimiterback to summary
public default String getEndDelimiter(ChangeSet changeSet)

Default implementation returns null

Parameters
changeSet:ChangeSet

Unused

Returns:String

null

getOverrideDelimiterback to summary
public default String getOverrideDelimiter(String endDelimiter)

Check for an override for a change-level delimiter

Parameters
endDelimiter:String

The endDelimiter to override

Returns:String

String The override setting

getPriorityback to summary
public int getPriority()

Return the plugin priority

Returns:int

int

modifyChangeSetsback to summary
public void modifyChangeSets(ChangeSet changeSet, ModifyChangeSets modifyChangeSets)

Given a change set and a ModifyChangeSets instance, perform the modifications

Parameters
changeSet:ChangeSet

The change set to modify

modifyChangeSets:ModifyChangeSets

The modifier