Top Fields Methods
liquibase.changelog

public Interface ChangeLogHistoryService

extends Plugin
Known Direct Implementers
liquibase.changelog.MockChangeLogHistoryService, liquibase.changelog.AbstractChangeLogHistoryService
Imports
liquibase.Contexts, .LabelExpression, liquibase.database.Database, liquibase.exception.DatabaseException, .DatabaseHistoryException, .LiquibaseException, liquibase.plugin.Plugin, java.util.Date, .List

Field Summary

Inherited from liquibase.plugin.Plugin:
PRIORITY_DATABASEPRIORITY_DEFAULTPRIORITY_NOT_APPLICABLEPRIORITY_SPECIALIZED

Method Summary

Modifier and TypeMethod and Description
public void
clearAllCheckSums()

public void
destroy()

public void
generateDeploymentId()

public String
getDeploymentId()

public int
getNextSequenceValue()

public int
getPriority()

public RanChangeSet
getRanChangeSet(ChangeSet changeSet)

public List<RanChangeSet>
getRanChangeSets()

public default List<RanChangeSet>
getRanChangeSets(boolean allowChecksumsUpgrade)
Deprecated use getRanChangeSets() instead

This method was created to clear out MD5sum for upgrade purpose but after some refactoring the logic was moved to Update commands and it should have been removed as everywhere it is called only with boolean false, so for core it is the same as getRanChangeSets().

public Date
getRanDate(ChangeSet changeSet)

Returns the date the given changeSet was ran.

public ChangeSet.RunStatus
getRunStatus(ChangeSet changeSet)

public void
init()

Ensures the change log history container is correctly initialized for use.

public boolean

Returns:

false if we have checksums different from liquibase.ChecksumVersion#latest().getVersion() in the dbcl table.
isDatabaseChecksumsCompatible()

This method should return true if all checksums in dbcl table have the same version as liquibase.ChecksumVersion#latest().getVersion().

public void
removeFromHistory(ChangeSet changeSet)

public default void
replaceChecksum(ChangeSet changeSet)

By default does nothing to keep compatibility with older versions, but subclasses may like to implement this method to support checksum upgrades.

public void
reset()

public void
resetDeploymentId()

public void
setDatabase(Database database)

public void
setExecType(ChangeSet changeSet, ChangeSet.ExecType execType)

public boolean
supports(Database database)

public void
tag(String tagString)

public boolean
tagExists(String tag)

public void
upgradeChecksums(final DatabaseChangeLog databaseChangeLog, final Contexts contexts, LabelExpression labels)

Updates null checksum values

Method Detail

clearAllCheckSumsback to summary
public void clearAllCheckSums() throws LiquibaseException
destroyback to summary
public void destroy() throws DatabaseException
generateDeploymentIdback to summary
public void generateDeploymentId()
getDeploymentIdback to summary
public String getDeploymentId()
getNextSequenceValueback to summary
public int getNextSequenceValue() throws LiquibaseException
getPriorityback to summary
public int getPriority()
getRanChangeSetback to summary
public RanChangeSet getRanChangeSet(ChangeSet changeSet) throws DatabaseException, DatabaseHistoryException
getRanChangeSetsback to summary
public List<RanChangeSet> getRanChangeSets() throws DatabaseException
getRanChangeSetsback to summary
public default List<RanChangeSet> getRanChangeSets(boolean allowChecksumsUpgrade) throws DatabaseException

Deprecated

use getRanChangeSets() instead

This method was created to clear out MD5sum for upgrade purpose but after some refactoring the logic was moved to Update commands and it should have been removed as everywhere it is called only with boolean false, so for core it is the same as getRanChangeSets().

Annotations
@Deprecated
getRanDateback to summary
public Date getRanDate(ChangeSet changeSet) throws DatabaseException, DatabaseHistoryException

Returns the date the given changeSet was ran. Returns null if changeSet was not null.

getRunStatusback to summary
public ChangeSet.RunStatus getRunStatus(ChangeSet changeSet) throws DatabaseException, DatabaseHistoryException
initback to summary
public void init() throws DatabaseException

Ensures the change log history container is correctly initialized for use. This method may be called multiple times so it should check state as needed.

isDatabaseChecksumsCompatibleback to summary
public boolean isDatabaseChecksumsCompatible()

This method should return true if all checksums in dbcl table have the same version as liquibase.ChecksumVersion#latest().getVersion(). This method is used by Update command family in order to know if there are old checksum versions in the database that should be updated or if it can proceed with fast checksum update process. IF your implementation does not validate dbcl table then return false.

Returns:boolean

false if we have checksums different from liquibase.ChecksumVersion#latest().getVersion() in the dbcl table.

removeFromHistoryback to summary
public void removeFromHistory(ChangeSet changeSet) throws DatabaseException
replaceChecksumback to summary
public default void replaceChecksum(ChangeSet changeSet) throws DatabaseException

By default does nothing to keep compatibility with older versions, but subclasses may like to implement this method to support checksum upgrades.

resetback to summary
public void reset()
resetDeploymentIdback to summary
public void resetDeploymentId()
setDatabaseback to summary
public void setDatabase(Database database)
setExecTypeback to summary
public void setExecType(ChangeSet changeSet, ChangeSet.ExecType execType) throws DatabaseException
supportsback to summary
public boolean supports(Database database)
tagback to summary
public void tag(String tagString) throws DatabaseException
tagExistsback to summary
public boolean tagExists(String tag) throws DatabaseException
upgradeChecksumsback to summary
public void upgradeChecksums(final DatabaseChangeLog databaseChangeLog, final Contexts contexts, LabelExpression labels) throws DatabaseException

Updates null checksum values