Interface ChangeSetService

All Superinterfaces:
Plugin
All Known Implementing Classes:
StandardChangeSetService

public interface ChangeSetService extends 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.
  • Method Details

    • getPriority

      int getPriority()
      Return the plugin priority
      Returns:
      int
    • createChangeSet

      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
      Parameters:
      id -
      author -
      alwaysRun -
      runOnChange -
      filePath -
      contextFilter -
      dbmsList -
      runWith -
      runWithSpoolFile -
      runInTransaction -
      quotingStrategy -
      databaseChangeLog -
      Returns:
      ChangeSet
    • createChangeSet

      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
      Parameters:
      id -
      author -
      alwaysRun -
      runOnChange -
      filePath -
      contextFilter -
      dbmsList -
      databaseChangeLog -
      Returns:
      ChangeSet
    • createChangeSet

      ChangeSet createChangeSet(DatabaseChangeLog databaseChangeLog)
      Create a change set with the changelog
      Parameters:
      databaseChangeLog - Construct this change set with the DatabaseChangeLog
      Returns:
      ChangeSet
    • createModifyChangeSets

      ModifyChangeSets createModifyChangeSets(ParsedNode node) throws ParsedNodeException
      Create the ModifyChangeSets instance which will do the modifications
      Parameters:
      node - The ParsedNode that was created during load
      Returns:
      ModifyChangeSets The object which will perform the modifications
      Throws:
      ParsedNodeException - Thrown if unable to access values from the node
    • createModifyChangeSets

      default ModifyChangeSets createModifyChangeSets(String runWith, String runWithSpool)
      Create the ModifyChangeSets instance which will do the modifications
      Parameters:
      runWith - The runWith value
      runWithSpool - The runWithSpool value
      Returns:
      ModifyChangeSets The object which will perform the modifications
    • modifyChangeSets

      void modifyChangeSets(ChangeSet changeSet, ModifyChangeSets modifyChangeSets)
      Given a change set and a ModifyChangeSets instance, perform the modifications
      Parameters:
      changeSet - The change set to modify
      modifyChangeSets - The modifier
    • getOverrideDelimiter

      default String getOverrideDelimiter(String endDelimiter)
      Check for an override for a change-level delimiter
      Parameters:
      endDelimiter - The endDelimiter to override
      Returns:
      String The override setting
    • getEndDelimiter

      default String getEndDelimiter(ChangeSet changeSet)
      Default implementation returns null
      Parameters:
      changeSet - Unused
      Returns:
      null
    • getOverrideStripComments

      default Boolean getOverrideStripComments(boolean stripComments)
      Check for an override for a change-level strip comments
      Parameters:
      stripComments - The stripComments to override
      Returns:
      String The override setting
    • getStripComments

      default Boolean getStripComments(ChangeSet changeSet)
      Default implementation returns null
      Parameters:
      changeSet - Unused