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 enum	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 final String	CHANGE_SET
static final String	CONTEXT
static final String	CONTEXT_FILTER
static final String	DBMS
static final String	ENDS_WITH_FILTER
static final String	ERROR_IF_MISSING
static final String	ERROR_IF_MISSING_OR_EMPTY
static final String	FILE
static final String	FILTER
static final String	GLOBAL
static final String	IGNORE
static final String	INCLUDE_ALL_CHANGELOGS
static final String	INCLUDE_CHANGELOG
static final String	LABELS
static final String	LOGICAL_FILE_PATH
static final String	MAX_DEPTH
static final String	MIN_DEPTH
static final String	MODIFY_CHANGE_SETS
static final String	NAME
static final String	PATH
static final String	PRE_CONDITIONS
static final String	PROPERTY
static final String	RELATIVE_TO_CHANGELOG_FILE
static final String	REMOVE_CHANGE_SET_PROPERTY
static final String	RESOURCE_COMPARATOR
static final String	RESOURCE_FILTER
static final String	SEEN_CHANGELOGS_PATHS_SCOPE_KEY
static final String	VALUE

Constructor Summary

Constructors

Constructor	Description
DatabaseChangeLog()
DatabaseChangeLog(String physicalFilePath)

Method Summary

Modifier and Type	Method	Description
void	addChangeSet(ChangeSet changeSet)
void	clearCheckSums()
int	compareTo(DatabaseChangeLog o)
protected ChangeSet	createChangeSet(ParsedNode node, ResourceAccessor resourceAccessor)
static String	detectExternalChangelogPathForm(String path)	Returns a human-readable description of the external-path form detected in path, or null if the path does not match any external pattern that requireRelativeChangelogPathOrThrow(String, boolean, String) would reject.
Comparator<String>	determineResourceComparator(String resourceComparatorDef)
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. use include(String, boolean, boolean, ResourceAccessor, ContextExpression, Labels, Boolean, String, OnUnknownFileFormat)
SortedSet<Resource>	findResources(String pathName, boolean isRelativeToChangelogFile, IncludeAllFilter resourceFilter, boolean errorIfMissingOrEmpty, Comparator<String> resourceComparator, ResourceAccessor resourceAccessor, int minDepth, int maxDepth, String endsWithFilter)
ChangeSet	getChangeSet(String path, String author, String id)
ChangeSet	getChangeSet(RanChangeSet ranChangeSet)
List<ChangeSet>	getChangeSets(String path, String author, String id)
List<ChangeSet>	getChangeSets(RanChangeSet ranChangeSet)
ContextExpression	getContexts()	Deprecated. use invalid reference #getContextFilter()
String	getFilePath()
String	getLogicalFilePath()
PreconditionContainer	getPreconditions()
String	getRawLogicalFilePath()
DatabaseChangeLog	getRootChangeLog()
protected Comparator<String>	getStandardChangeLogComparator()
protected void	handleChildNode(ParsedNode node, ResourceAccessor resourceAccessor)
protected void	handleChildNode(ParsedNode node, ResourceAccessor resourceAccessor, Map<String,Object> nodeScratch)
void	handleChildNodeHelper(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)	Deprecated. use include(String, boolean, boolean, ResourceAccessor, ContextExpression, Labels, Boolean, String, OnUnknownFileFormat)
boolean	include(String fileName, boolean isRelativePath, boolean errorIfMissing, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, Boolean ignore, boolean logEveryUnknownFileFormat)	Deprecated. use include(String, boolean, boolean, ResourceAccessor, ContextExpression, Labels, Boolean, String, OnUnknownFileFormat)
boolean	include(String fileName, boolean isRelativePath, boolean errorIfMissing, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, Boolean ignore, String logicalFilePath, DatabaseChangeLog.OnUnknownFileFormat onUnknownFileFormat)
boolean	include(String fileName, boolean isRelativePath, boolean errorIfMissing, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, Boolean ignore, String logicalFilePath, DatabaseChangeLog.OnUnknownFileFormat onUnknownFileFormat, ModifyChangeSets modifyChangeSets)
boolean	include(String fileName, boolean isRelativePath, boolean errorIfMissing, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, Boolean ignore, DatabaseChangeLog.OnUnknownFileFormat onUnknownFileFormat)	Deprecated. use include(String, boolean, boolean, ResourceAccessor, ContextExpression, Labels, Boolean, String, OnUnknownFileFormat)
void	includeAll(String pathName, boolean isRelativeToChangelogFile, IncludeAllFilter resourceFilter, boolean errorIfMissingOrEmpty, Comparator<String> resourceComparator, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, LabelExpression labelExpression, boolean ignore)	Deprecated. use includeAll(String, boolean, IncludeAllFilter, boolean, Comparator, ResourceAccessor, ContextExpression, Labels, boolean, String, int, int)
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. use throws SetupException
void	includeAll(String pathName, boolean isRelativeToChangelogFile, IncludeAllFilter resourceFilter, boolean errorIfMissingOrEmpty, Comparator<String> resourceComparator, ResourceAccessor resourceAccessor, ContextExpression includeContextFilter, Labels labels, boolean ignore, String logicalFilePath, 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, String logicalFilePath, int minDepth, int maxDepth, String endsWithFilter, ModifyChangeSets modifyChangeSets)
boolean	isDbmsMatch(String dbmsList)
boolean	isDbmsMatch(Set<String> dbmsSet)
void	load(ParsedNode parsedNode, ResourceAccessor resourceAccessor)
static String	normalizePath(String filePath)
static void	requireRelativeChangelogPathOrThrow(String path, boolean relativeToChangelogFile, String elementName)	Defence-in-depth gate for <include>, <includeAll>, and <sqlFile> path resolution when GlobalConfiguration.ALLOW_EXTERNAL_CHANGELOG_PATHS has been set to false.
void	setChangeLogParameters(ChangeLogParameters changeLogParameters)
void	setContextFilter(ContextExpression contextFilter)
void	setContexts(ContextExpression contexts)	Deprecated. use setContextFilter(ContextExpression)
void	setIncludeContextFilter(ContextExpression includeContextFilter)
void	setIncludeContexts(ContextExpression includeContexts)	Deprecated. use setIncludeContextFilter(ContextExpression)
void	setIncludeIgnore(boolean ignore)
void	setIncludeLabels(LabelExpression labels)	Deprecated. Correct version is setIncludeLabels(Labels).
void	setIncludeLabels(Labels labels)
void	setLogicalFilePath(String logicalFilePath)
void	setObjectQuotingStrategy(ObjectQuotingStrategy objectQuotingStrategy)
void	setParentChangeLog(DatabaseChangeLog parentChangeLog)
void	setPhysicalFilePath(String physicalFilePath)
void	setPreconditions(PreconditionContainer precondition)
void	setRootChangeLog(DatabaseChangeLog rootChangeLog)
void	setRuntimeEnvironment(RuntimeEnvironment runtimeEnvironment)
String	toString()
void	validate(Database database, String... contexts)
void	validate(Database database, Contexts contexts, LabelExpression labelExpression)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SEEN_CHANGELOGS_PATHS_SCOPE_KEY

public static final String SEEN_CHANGELOGS_PATHS_SCOPE_KEY

See Also:

• Constant Field Values

FILE

public static final String FILE

See Also:

• Constant Field Values

CONTEXT_FILTER

public static final String CONTEXT_FILTER

See Also:

• Constant Field Values

CONTEXT

public static final String CONTEXT

See Also:

• Constant Field Values

LABELS

public static final String LABELS

See Also:

• Constant Field Values

IGNORE

public static final String IGNORE

See Also:

• Constant Field Values

RELATIVE_TO_CHANGELOG_FILE

public static final String RELATIVE_TO_CHANGELOG_FILE

See Also:

• Constant Field Values

LOGICAL_FILE_PATH

public static final String LOGICAL_FILE_PATH

See Also:

• Constant Field Values

ERROR_IF_MISSING

public static final String ERROR_IF_MISSING

See Also:

• Constant Field Values

MODIFY_CHANGE_SETS

public static final String MODIFY_CHANGE_SETS

See Also:

• Constant Field Values

PATH

public static final String PATH

See Also:

• Constant Field Values

FILTER

public static final String FILTER

See Also:

• Constant Field Values

RESOURCE_FILTER

public static final String RESOURCE_FILTER

See Also:

• Constant Field Values

RESOURCE_COMPARATOR

public static final String RESOURCE_COMPARATOR

See Also:

• Constant Field Values

MIN_DEPTH

public static final String MIN_DEPTH

See Also:

• Constant Field Values

MAX_DEPTH

public static final String MAX_DEPTH

See Also:

• Constant Field Values

ENDS_WITH_FILTER

public static final String ENDS_WITH_FILTER

See Also:

• Constant Field Values

ERROR_IF_MISSING_OR_EMPTY

public static final String ERROR_IF_MISSING_OR_EMPTY

See Also:

• Constant Field Values

CHANGE_SET

public static final String CHANGE_SET

See Also:

• Constant Field Values

DBMS

public static final String DBMS

See Also:

• Constant Field Values

INCLUDE_CHANGELOG

public static final String INCLUDE_CHANGELOG

See Also:

• Constant Field Values

INCLUDE_ALL_CHANGELOGS

public static final String INCLUDE_ALL_CHANGELOGS

See Also:

• Constant Field Values

PRE_CONDITIONS

public static final String PRE_CONDITIONS

See Also:

• Constant Field Values

REMOVE_CHANGE_SET_PROPERTY

public static final String REMOVE_CHANGE_SET_PROPERTY

See Also:

• Constant Field Values

PROPERTY

public static final String PROPERTY

See Also:

• Constant Field Values

NAME

public static final String NAME

See Also:

• Constant Field Values

VALUE

public static final String VALUE

See Also:

• Constant Field Values

GLOBAL

public static final String GLOBAL

See Also:

• Constant Field Values

Constructor Details

DatabaseChangeLog

public DatabaseChangeLog()

DatabaseChangeLog

public DatabaseChangeLog(String physicalFilePath)

Method Details

setRootChangeLog

public void setRootChangeLog(DatabaseChangeLog rootChangeLog)

getRootChangeLog

public DatabaseChangeLog getRootChangeLog()

setParentChangeLog

public void setParentChangeLog(DatabaseChangeLog parentChangeLog)

setRuntimeEnvironment

public void setRuntimeEnvironment(RuntimeEnvironment runtimeEnvironment)

getPreconditions

public PreconditionContainer getPreconditions()

Specified by:

getPreconditions in interface Conditional

setPreconditions

public void setPreconditions(PreconditionContainer precondition)

Specified by:

setPreconditions in interface Conditional

setChangeLogParameters

public void setChangeLogParameters(ChangeLogParameters changeLogParameters)

setPhysicalFilePath

public void setPhysicalFilePath(String physicalFilePath)

getRawLogicalFilePath

public String getRawLogicalFilePath()

getLogicalFilePath

public String getLogicalFilePath()

setLogicalFilePath

public void setLogicalFilePath(String logicalFilePath)

getFilePath

public String getFilePath()

setObjectQuotingStrategy

public void setObjectQuotingStrategy(ObjectQuotingStrategy objectQuotingStrategy)

getContexts

@Deprecated
public ContextExpression getContexts()

Deprecated.

use

invalid reference

#getContextFilter()

setContexts

@Deprecated
public void setContexts(ContextExpression contexts)

Deprecated.

use setContextFilter(ContextExpression)

setContextFilter

public void setContextFilter(ContextExpression contextFilter)

setIncludeLabels

@Deprecated
public void setIncludeLabels(LabelExpression labels)

Deprecated.

Correct version is setIncludeLabels(Labels). Kept for backwards compatibility.

setIncludeLabels

public void setIncludeLabels(Labels labels)

setIncludeIgnore

public void setIncludeIgnore(boolean ignore)

setIncludeContexts

@Deprecated
public void setIncludeContexts(ContextExpression includeContexts)

Deprecated.

use setIncludeContextFilter(ContextExpression)

setIncludeContextFilter

public void setIncludeContextFilter(ContextExpression includeContextFilter)

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(DatabaseChangeLog o)

Specified by:

compareTo in interface Comparable<DatabaseChangeLog>

getChangeSet

public ChangeSet getChangeSet(String path,
 String author,
 String id)

getChangeSets

public List<ChangeSet> getChangeSets(String path,
 String author,
 String id)

addChangeSet

public void addChangeSet(ChangeSet changeSet)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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

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

handleChildNodeHelper

public void handleChildNodeHelper(ParsedNode node,
 ResourceAccessor resourceAccessor,
 Map<String,Object> nodeScratch)
                           throws ParsedNodeException,
SetupException

Throws:

ParsedNodeException

SetupException

determineResourceComparator

public Comparator<String> determineResourceComparator(String resourceComparatorDef)

isDbmsMatch

public boolean isDbmsMatch(String dbmsList)

isDbmsMatch

public boolean isDbmsMatch(Set<String> dbmsSet)

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.

use includeAll(String, boolean, IncludeAllFilter, boolean, Comparator, ResourceAccessor, ContextExpression, Labels, boolean, String, int, int)

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,
 String logicalFilePath,
 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.

use throws SetupException

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,
 String logicalFilePath,
 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.

use include(String, boolean, boolean, ResourceAccessor, ContextExpression, Labels, Boolean, String, OnUnknownFileFormat)

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.

use include(String, boolean, boolean, ResourceAccessor, ContextExpression, Labels, Boolean, String, OnUnknownFileFormat)

Throws:

LiquibaseException

include

@Deprecated
public boolean include(String fileName,
 boolean isRelativePath,
 boolean errorIfMissing,
 ResourceAccessor resourceAccessor,
 ContextExpression includeContextFilter,
 Labels labels,
 Boolean ignore,
 boolean logEveryUnknownFileFormat)
                throws LiquibaseException

Deprecated.

use include(String, boolean, boolean, ResourceAccessor, ContextExpression, Labels, Boolean, String, OnUnknownFileFormat)

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

Deprecated.

use include(String, boolean, boolean, ResourceAccessor, ContextExpression, Labels, Boolean, String, OnUnknownFileFormat)

Throws:

LiquibaseException

include

public boolean include(String fileName,
 boolean isRelativePath,
 boolean errorIfMissing,
 ResourceAccessor resourceAccessor,
 ContextExpression includeContextFilter,
 Labels labels,
 Boolean ignore,
 String logicalFilePath,
 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,
 String logicalFilePath,
 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()

requireRelativeChangelogPathOrThrow

public static void requireRelativeChangelogPathOrThrow(String path,
 boolean relativeToChangelogFile,
 String elementName)
                                                throws SetupException

Defence-in-depth gate for <include>, <includeAll>, and <sqlFile> path resolution when GlobalConfiguration.ALLOW_EXTERNAL_CHANGELOG_PATHS has been set to false. Rejects two path forms that escape the configured ResourceAccessor search-path scope:

• The classpath: URI prefix — reaches JAR resources or other classpath locations outside the search path.
• Absolute filesystem paths (Unix /..., UNC \\..., Windows drive-letter C:...) — reach arbitrary filesystem locations.

Bypassed when relativeToChangelogFile=true because the path is then resolved relative to the parent changelog file and cannot escape its directory. Bypassed when the flag is true (the default — preserves Spring Boot classpath:db/changelog/... patterns and other documented usage). See CWE-22.

Throws:

SetupException - with a message that names the flag in both directions and the specific pattern detected, so the operator can either remove the offending prefix, set relativeToChangelogFile=true, or re-enable external paths.

detectExternalChangelogPathForm

public static String detectExternalChangelogPathForm(String path)

Returns a human-readable description of the external-path form detected in path, or null if the path does not match any external pattern that requireRelativeChangelogPathOrThrow(String, boolean, String) would reject. Public so callers (e.g. SQLFileChange.validate) can build context-appropriate error messages without re-implementing the detection.

normalizePath

public static String normalizePath(String filePath)

clearCheckSums

public void clearCheckSums()