Package liquibase.changelog
Class DatabaseChangeLog
- java.lang.Object
-
- liquibase.changelog.DatabaseChangeLog
-
- All Implemented Interfaces:
Comparable<DatabaseChangeLog>
,Conditional
public class DatabaseChangeLog extends Object implements Comparable<DatabaseChangeLog>, Conditional
Encapsulates the information stored in the change log XML file.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DatabaseChangeLog.OnUnknownFileFormat
Controls what to do when including a file with a format that isn't recognized by a changelog parser.
-
Field Summary
Fields Modifier and Type Field Description static String
SEEN_CHANGELOGS_PATHS_SCOPE_KEY
-
Constructor Summary
Constructors Constructor Description DatabaseChangeLog()
DatabaseChangeLog(String physicalFilePath)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addChangeSet(ChangeSet changeSet)
void
clearCheckSums()
int
compareTo(DatabaseChangeLog o)
protected ChangeSet
createChangeSet(ParsedNode node, ResourceAccessor resourceAccessor)
boolean
equals(Object o)
protected void
expandExpressions(ParsedNode parsedNode)
SortedSet<Resource>
findResources(String pathName, boolean isRelativeToChangelogFile, IncludeAllFilter resourceFilter, boolean errorIfMissingOrEmpty, Comparator<String> resourceComparator, ResourceAccessor resourceAccessor, int minDepth, int maxDepth)
Deprecated.SortedSet<Resource>
findResources(String pathName, boolean isRelativeToChangelogFile, IncludeAllFilter resourceFilter, boolean errorIfMissingOrEmpty, Comparator<String> resourceComparator, ResourceAccessor resourceAccessor, int minDepth, int maxDepth, String endsWithFilter)
ChangeLogParameters
getChangeLogParameters()
ChangeSet
getChangeSet(String path, String author, String id)
ChangeSet
getChangeSet(RanChangeSet ranChangeSet)
List<ChangeSet>
getChangeSets()
List<ChangeSet>
getChangeSets(String path, String author, String id)
List<ChangeSet>
getChangeSets(RanChangeSet ranChangeSet)
List<ChangeVisitor>
getChangeVisitors()
ContextExpression
getContextFilter()
ContextExpression
getContexts()
Deprecated.String
getFilePath()
ContextExpression
getIncludeContextFilter()
Labels
getIncludeLabels()
String
getLogicalFilePath()
ObjectQuotingStrategy
getObjectQuotingStrategy()
DatabaseChangeLog
getParentChangeLog()
String
getPhysicalFilePath()
PreconditionContainer
getPreconditions()
DatabaseChangeLog
getRootChangeLog()
RuntimeEnvironment
getRuntimeEnvironment()
List<ChangeSet>
getSkippedChangeSets()
protected Comparator<String>
getStandardChangeLogComparator()
protected void
handleChildNode(ParsedNode node, ResourceAccessor resourceAccessor)
protected void
handleChildNode(ParsedNode node, ResourceAccessor resourceAccessor, Map<String,Object> nodeScratch)
int
hashCode()
boolean
include(String fileName, boolean isRelativePath, boolean errorIfMissing, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, LabelExpression labelExpression, Boolean ignore, boolean logEveryUnknownFileFormat)
boolean
include(String fileName, boolean isRelativePath, boolean errorIfMissing, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, Boolean ignore, boolean logEveryUnknownFileFormat)
boolean
include(String fileName, boolean isRelativePath, boolean errorIfMissing, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, Boolean ignore, DatabaseChangeLog.OnUnknownFileFormat onUnknownFileFormat)
boolean
include(String fileName, boolean isRelativePath, boolean errorIfMissing, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, Boolean ignore, DatabaseChangeLog.OnUnknownFileFormat onUnknownFileFormat, ModifyChangeSets modifyChangeSets)
void
includeAll(String pathName, boolean isRelativeToChangelogFile, IncludeAllFilter resourceFilter, boolean errorIfMissingOrEmpty, Comparator<String> resourceComparator, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, LabelExpression labelExpression, boolean ignore)
void
includeAll(String pathName, boolean isRelativeToChangelogFile, IncludeAllFilter resourceFilter, boolean errorIfMissingOrEmpty, Comparator<String> resourceComparator, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, boolean ignore, int minDepth, int maxDepth)
void
includeAll(String pathName, boolean isRelativeToChangelogFile, IncludeAllFilter resourceFilter, boolean errorIfMissingOrEmpty, Comparator<String> resourceComparator, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, boolean ignore, int minDepth, int maxDepth, String endsWithFilter, ModifyChangeSets modifyChangeSets)
void
includeAll(String pathName, boolean isRelativeToChangelogFile, IncludeAllFilter resourceFilter, boolean errorIfMissingOrEmpty, Comparator<String> resourceComparator, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, boolean ignore, int minDepth, int maxDepth, ModifyChangeSets modifyChangeSets)
Deprecated.boolean
isDbmsMatch(String dbmsList)
boolean
isDbmsMatch(Set<String> dbmsSet)
boolean
isIncludeIgnore()
void
load(ParsedNode parsedNode, ResourceAccessor resourceAccessor)
static String
normalizePath(String filePath)
void
setChangeLogParameters(ChangeLogParameters changeLogParameters)
void
setContextFilter(ContextExpression contextFilter)
void
setContexts(ContextExpression contexts)
Deprecated.void
setIncludeContextFilter(ContextExpression includeContextFilter)
void
setIncludeContexts(ContextExpression includeContexts)
Deprecated.void
setIncludeIgnore(boolean ignore)
void
setIncludeLabels(LabelExpression labels)
Deprecated.Correct version issetIncludeLabels(Labels)
.void
setIncludeLabels(Labels labels)
void
setLogicalFilePath(String logicalFilePath)
void
setObjectQuotingStrategy(ObjectQuotingStrategy objectQuotingStrategy)
void
setParentChangeLog(DatabaseChangeLog parentChangeLog)
void
setPhysicalFilePath(String physicalFilePath)
void
setPreconditions(PreconditionContainer precond)
void
setRootChangeLog(DatabaseChangeLog rootChangeLog)
void
setRuntimeEnvironment(RuntimeEnvironment runtimeEnvironment)
String
toString()
void
validate(Database database, String... contexts)
void
validate(Database database, Contexts contexts, LabelExpression labelExpression)
-
-
-
Field Detail
-
SEEN_CHANGELOGS_PATHS_SCOPE_KEY
public static final String SEEN_CHANGELOGS_PATHS_SCOPE_KEY
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
DatabaseChangeLog
public DatabaseChangeLog()
-
DatabaseChangeLog
public DatabaseChangeLog(String physicalFilePath)
-
-
Method Detail
-
setRootChangeLog
public void setRootChangeLog(DatabaseChangeLog rootChangeLog)
-
getRootChangeLog
public DatabaseChangeLog getRootChangeLog()
-
setParentChangeLog
public void setParentChangeLog(DatabaseChangeLog parentChangeLog)
-
getParentChangeLog
public DatabaseChangeLog getParentChangeLog()
-
getRuntimeEnvironment
public RuntimeEnvironment getRuntimeEnvironment()
-
setRuntimeEnvironment
public void setRuntimeEnvironment(RuntimeEnvironment runtimeEnvironment)
-
getPreconditions
public PreconditionContainer getPreconditions()
- Specified by:
getPreconditions
in interfaceConditional
-
setPreconditions
public void setPreconditions(PreconditionContainer precond)
- Specified by:
setPreconditions
in interfaceConditional
-
getChangeLogParameters
public ChangeLogParameters getChangeLogParameters()
-
setChangeLogParameters
public void setChangeLogParameters(ChangeLogParameters changeLogParameters)
-
getPhysicalFilePath
public String getPhysicalFilePath()
-
setPhysicalFilePath
public void setPhysicalFilePath(String physicalFilePath)
-
getLogicalFilePath
public String getLogicalFilePath()
-
setLogicalFilePath
public void setLogicalFilePath(String logicalFilePath)
-
getFilePath
public String getFilePath()
-
getObjectQuotingStrategy
public ObjectQuotingStrategy getObjectQuotingStrategy()
-
setObjectQuotingStrategy
public void setObjectQuotingStrategy(ObjectQuotingStrategy objectQuotingStrategy)
-
getContexts
public ContextExpression getContexts()
Deprecated.
-
setContexts
public void setContexts(ContextExpression contexts)
Deprecated.
-
getContextFilter
public ContextExpression getContextFilter()
-
setContextFilter
public void setContextFilter(ContextExpression contextFilter)
-
getIncludeContextFilter
public ContextExpression getIncludeContextFilter()
-
setIncludeLabels
public void setIncludeLabels(LabelExpression labels)
Deprecated.Correct version issetIncludeLabels(Labels)
. Kept for backwards compatibility.
-
setIncludeLabels
public void setIncludeLabels(Labels labels)
-
getIncludeLabels
public Labels getIncludeLabels()
-
setIncludeIgnore
public void setIncludeIgnore(boolean ignore)
-
isIncludeIgnore
public boolean isIncludeIgnore()
-
setIncludeContexts
public void setIncludeContexts(ContextExpression includeContexts)
Deprecated.
-
setIncludeContextFilter
public void setIncludeContextFilter(ContextExpression includeContextFilter)
-
compareTo
public int compareTo(DatabaseChangeLog o)
- Specified by:
compareTo
in interfaceComparable<DatabaseChangeLog>
-
getChangeVisitors
public List<ChangeVisitor> getChangeVisitors()
-
addChangeSet
public void addChangeSet(ChangeSet changeSet)
-
validate
public void validate(Database database, String... contexts) throws LiquibaseException
- Throws:
LiquibaseException
-
validate
public void validate(Database database, Contexts contexts, LabelExpression labelExpression) throws LiquibaseException
- Throws:
LiquibaseException
-
getChangeSet
public ChangeSet getChangeSet(RanChangeSet ranChangeSet)
-
getChangeSets
public List<ChangeSet> getChangeSets(RanChangeSet ranChangeSet)
-
load
public void load(ParsedNode parsedNode, ResourceAccessor resourceAccessor) throws ParsedNodeException, SetupException
- Throws:
ParsedNodeException
SetupException
-
expandExpressions
protected void expandExpressions(ParsedNode parsedNode) throws UnknownChangeLogParameterException
-
handleChildNode
protected void handleChildNode(ParsedNode node, ResourceAccessor resourceAccessor) throws ParsedNodeException, SetupException
- Throws:
ParsedNodeException
SetupException
-
handleChildNode
protected void handleChildNode(ParsedNode node, ResourceAccessor resourceAccessor, Map<String,Object> nodeScratch) throws ParsedNodeException, SetupException
- Throws:
ParsedNodeException
SetupException
-
isDbmsMatch
public boolean isDbmsMatch(String dbmsList)
-
includeAll
@Deprecated public void includeAll(String pathName, boolean isRelativeToChangelogFile, IncludeAllFilter resourceFilter, boolean errorIfMissingOrEmpty, Comparator<String> resourceComparator, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, LabelExpression labelExpression, boolean ignore) throws SetupException
Deprecated.- Throws:
SetupException
-
includeAll
public void includeAll(String pathName, boolean isRelativeToChangelogFile, IncludeAllFilter resourceFilter, boolean errorIfMissingOrEmpty, Comparator<String> resourceComparator, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, boolean ignore, int minDepth, int maxDepth) throws SetupException
- Throws:
SetupException
-
includeAll
@Deprecated public void includeAll(String pathName, boolean isRelativeToChangelogFile, IncludeAllFilter resourceFilter, boolean errorIfMissingOrEmpty, Comparator<String> resourceComparator, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, boolean ignore, int minDepth, int maxDepth, ModifyChangeSets modifyChangeSets) throws SetupException
Deprecated.- Throws:
SetupException
-
includeAll
public void includeAll(String pathName, boolean isRelativeToChangelogFile, IncludeAllFilter resourceFilter, boolean errorIfMissingOrEmpty, Comparator<String> resourceComparator, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, boolean ignore, int minDepth, int maxDepth, String endsWithFilter, ModifyChangeSets modifyChangeSets) throws SetupException
- Throws:
SetupException
-
findResources
@Deprecated public SortedSet<Resource> findResources(String pathName, boolean isRelativeToChangelogFile, IncludeAllFilter resourceFilter, boolean errorIfMissingOrEmpty, Comparator<String> resourceComparator, ResourceAccessor resourceAccessor, int minDepth, int maxDepth) throws SetupException
Deprecated.- Throws:
SetupException
-
findResources
public SortedSet<Resource> findResources(String pathName, boolean isRelativeToChangelogFile, IncludeAllFilter resourceFilter, boolean errorIfMissingOrEmpty, Comparator<String> resourceComparator, ResourceAccessor resourceAccessor, int minDepth, int maxDepth, String endsWithFilter) throws SetupException
- Throws:
SetupException
-
include
@Deprecated public boolean include(String fileName, boolean isRelativePath, boolean errorIfMissing, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, LabelExpression labelExpression, Boolean ignore, boolean logEveryUnknownFileFormat) throws LiquibaseException
Deprecated.- Throws:
LiquibaseException
-
include
public boolean include(String fileName, boolean isRelativePath, boolean errorIfMissing, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, Boolean ignore, boolean logEveryUnknownFileFormat) throws LiquibaseException
Deprecated.- Throws:
LiquibaseException
-
include
public boolean include(String fileName, boolean isRelativePath, boolean errorIfMissing, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, Boolean ignore, DatabaseChangeLog.OnUnknownFileFormat onUnknownFileFormat) throws LiquibaseException
- Throws:
LiquibaseException
-
include
public boolean include(String fileName, boolean isRelativePath, boolean errorIfMissing, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, Boolean ignore, DatabaseChangeLog.OnUnknownFileFormat onUnknownFileFormat, ModifyChangeSets modifyChangeSets) throws LiquibaseException
- Throws:
LiquibaseException
-
createChangeSet
protected ChangeSet createChangeSet(ParsedNode node, ResourceAccessor resourceAccessor) throws ParsedNodeException
- Throws:
ParsedNodeException
-
getStandardChangeLogComparator
protected Comparator<String> getStandardChangeLogComparator()
-
clearCheckSums
public void clearCheckSums()
-
-