Liquibase 4.26.0 · liquibase.changelog.ChangeSet · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
public static enum	ChangeSet.ExecType
public static enum	ChangeSet.RunStatus
public static enum	ChangeSet.ValidationFailOption

Field Summary

Modifier and Type	Field and Description
private boolean	alwaysRun If set to true, the changeSet will be executed on every update.
private static final String	AND
private final Map<String, Object>	attributes
private String	author "author" defined in changeLog file.
private final DatabaseChangeLog	changeLog
private ChangeLogParameters	changeLogParameters
private final List<Change>	changes List of change objects defined in this changeset
protected CheckSum	checkSum
private static final String	CLOSE_BRACKET
private static final String	COMMA
private String	comments ChangeSet comments defined in changeLog file
private ContextExpression	contextFilter Runtime contexts in which the changeSet will be executed.
private String	created
private Set<String>	dbmsSet Databases for which this changeset should run.
private String	deploymentId Deployment ID stored in the databasechangelog table.
private String	errorMsg
private ChangeSet.ExecType	execType
private Boolean	failOnError If false, do not stop liquibase update execution if an error is thrown executing the changeSet.
private String	filePath File changeSet is defined in. May be a logical/non-physical string.
private List<String>	generatedSql
private String	id "id" specified in changeLog file.
private boolean	ignore If set to true, the changeSet will be ignored (skipped)
protected String	key
private Labels	labels "Labels" associated with this changeSet.
private String	logicalFilePath A logicalFilePath if defined
private ObjectQuotingStrategy	objectQuotingStrategy
private ChangeSet.ValidationFailOption	onValidationFail Behavior if the validation of any of the changeSet changes fails.
private static final String	OPEN_BRACKET
private PreconditionContainer	preconditions ChangeSet level preconditions defined for this changeSet
private final RollbackContainer	rollback Changes defined to roll back this changeSet
private ChangeSet.ExecType	rollbackExecType
private boolean	runInTransaction If true, the changeSet will run in a database transaction.
private boolean	runOnChange If set to true, the changeSet will be executed when the checksum changes.
private String	runOrder Allow changeSet to be ran "first" or "last".
private String	runWith ChangeSet level attribute to specify an Executor
private String	runWithSpoolFile ChangeSet level attribute to specify a spool file name
private final List<SqlVisitor>	sqlVisitors SqlVisitors defined for this changeset.
private CheckSum	storedCheckSum storedChecksum is used to make the checksum of a changeset that has already been run on a database available to liquibase extensions.
private String	storedFilePath File path stored in the databasechangelog table.
private boolean	validationFailed Stores if validation failed on this ChangeSet
private final Set<CheckSum>	validCheckSums List of checksums that are assumed to be valid besides the one stored in the database.
private static final String	WHITESPACE

Access	Constructor and Description
public	ChangeSet(DatabaseChangeLog databaseChangeLog)
public	ChangeSet(String id, String author, boolean alwaysRun, boolean runOnChange, String filePath, String contextFilter, String dbmsList, DatabaseChangeLog databaseChangeLog)
public	ChangeSet(String id, String author, boolean alwaysRun, boolean runOnChange, String filePath, String contextFilter, String dbmsList, boolean runInTransaction, DatabaseChangeLog databaseChangeLog)
public	ChangeSet(String id, String author, boolean alwaysRun, boolean runOnChange, String filePath, String contextFilter, String dbmsList, ObjectQuotingStrategy quotingStrategy, DatabaseChangeLog databaseChangeLog)
public	ChangeSet(String id, String author, boolean alwaysRun, boolean runOnChange, String filePath, String contextFilter, String dbmsList, boolean runInTransaction, ObjectQuotingStrategy quotingStrategy, DatabaseChangeLog databaseChangeLog)
public	ChangeSet(String id, String author, boolean alwaysRun, boolean runOnChange, String filePath, String contextFilter, String dbmsList, String runWith, String runWithSpoolFile, boolean runInTransaction, ObjectQuotingStrategy quotingStrategy, DatabaseChangeLog databaseChangeLog)

Method Summary

Modifier and Type	Method and Description
public void	addChange(Change change)
public void	addChangeSetMdcProperties()
public void	addRollbackChange(Change change)
public void	addRollBackSQL(String sql)
private void	addSqlFileMdc(SQLFileChange change)
private String	addSqlMdc(Change the change to read sql from change, Database the database to generate change sql against database, boolean controls generation of rollback sql statements or standard statements sql generateRollbackStatements) Adds changeset sql to mdc if the change is supported by the database
public void	addSqlVisitor(SqlVisitor sqlVisitor)
public void	addValidCheckSum(String text)
private void	appendContext(StringBuilder contextExpression, String contextToAppend, boolean notFirstContext)
private void	appendLabels(StringBuilder existingLabels, String labelToAppend, boolean notFirstContext)
public String	Returns: String buildFullContext() Build and return a string which contains both the changeset and inherited context
public String	Returns: String buildFullLabels() Build and return a string which contains both the changeset and inherited labels
public void	clearCheckSum()
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public ChangeSet.ExecType	execute(DatabaseChangeLog databaseChangeLog, Database database)
public ChangeSet.ExecType	Returns: should changeset be marked as ran execute(DatabaseChangeLog databaseChangeLog, ChangeExecListener listener, Database database) This method will actually execute each of the changes in the list against the specified database.
public CheckSum	generateCheckSum(ChecksumVersion version)
public Object	getAttribute(String attribute)
public String	getAuthor()
public DatabaseChangeLog	getChangeLog()
public ChangeLogParameters	getChangeLogParameters()
public List<Change>	getChanges() Returns an unmodifiable list of changes.
private List<ChangeVisitor>	getChangeVisitors()
public String	getComments()
public ContextExpression	getContextFilter()
public ContextExpression	getContexts() Deprecated use `getContextFilter()`
public String	getCreated()
public Set<String>	getDbmsSet()
public String	Returns: Deployment ID stored in the databasechangelog table. getDeploymentId()
public String	getDescription()
public Boolean	getFailOnError()
public String	Returns: either this object's logicalFilePath or the changelog's filepath (logical or physical) if not. getFilePath()
public String	getId()
public Collection<ContextExpression>	getInheritableContextFilter()
public Collection<Labels>	getInheritableLabels()
public Labels	getLabels()
public String	Returns: the logical file path defined on this node, or `null` if not set getLogicalFilePath() Returns the logical file path defined directly on this node.
public ObjectQuotingStrategy	getObjectQuotingStrategy()
public ChangeSet.ValidationFailOption	getOnValidationFail()
public PreconditionContainer	getPreconditions() Implements liquibase.precondition.Conditional.getPreconditions.
public RollbackContainer	getRollback()
public String	getRunOrder()
public String	Returns: the runWith value. If the runWith value is empty or not set this method will return null. getRunWith()
public String	getRunWithSpoolFile()
public String	getSerializableFieldNamespace(String field) Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldNamespace.
public Set<String>	getSerializableFields() Implements liquibase.serializer.LiquibaseSerializable.getSerializableFields.
public LiquibaseSerializable.SerializationType	getSerializableFieldType(String field) Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldType.
public Object	getSerializableFieldValue(String field) Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldValue.
public String	getSerializedObjectName() Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectName.
public String	getSerializedObjectNamespace() Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.
public List<SqlVisitor>	getSqlVisitors()
public CheckSum	Returns: storedCheckSum if it was executed otherwise null getStoredCheckSum() Gets storedCheckSum
public String	getStoredFilePath()
public Set<CheckSum>	getValidCheckSums()
protected void	handleChildNode(ParsedNode child, ResourceAccessor resourceAccessor)
protected void	handleRollbackNode(ParsedNode rollbackNode, ResourceAccessor resourceAccessor)
public boolean	hasCustomRollbackChanges() Returns whether custom rollback steps are specified for this changeSet, or whether auto-generated ones should be used
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
private boolean	ignoreSpecificChangeTypes(Change change, Database database)
public boolean	isAlwaysRun()
public boolean	isCheckSumValid(CheckSum storedCheckSum)
public boolean	isIgnore()
public boolean	isInheritableIgnore()
public boolean	isRunInTransaction()
public boolean	isRunOnChange()
public void	load(ParsedNode node, ResourceAccessor resourceAccessor) Implements liquibase.serializer.LiquibaseSerializable.load.
public static String	Returns: String The mapped value lookupExecutor(String The value from the input changeset runWith attribute executorName) Look for a configuration property that matches liquibase.
public void	removeAllChanges(Collection<?> collection) Method created to remove changes from a changeset
public void	rollback(Database database)
public void	rollback(Database database, ChangeExecListener listener)
public ParsedNode	serialize() Implements liquibase.serializer.LiquibaseSerializable.serialize.
public ChangeSet	setAttribute(String attribute, Object value)
public void	setChangeLogParameters(ChangeLogParameters changeLogParameters) Called by the changelog parsing process to pass the `ChangeLogParameters`.
public void	setComments(String comments)
public ChangeSet	setContextFilter(ContextExpression contextFilter)
public ChangeSet	setContexts(ContextExpression contexts) Deprecated use `setContextFilter(ContextExpression)`
public void	setCreated(String created)
protected void	setDbms(String dbmsList)
public void	setDeploymentId(String Deployment ID stored in the databasechangelog table. deploymentId)
public void	setFailOnError(Boolean failOnError)
public void	setFilePath(String filePath) Called to update file path from database entry when rolling back and ignoreClasspathPrefix is true.
public void	setIgnore(boolean ignore)
public void	setLabels(Labels labels)
public void	setLogicalFilePath(String logicalFilePath)
public void	setOnValidationFail(ChangeSet.ValidationFailOption onValidationFail)
public void	setPreconditions(PreconditionContainer preconditionContainer) Implements liquibase.precondition.Conditional.setPreconditions.
public void	setRunOrder(String runOrder)
public void	setRunWith(String runWith)
public void	setRunWithSpoolFile(String runWithSpoolFile)
public void	setStoredCheckSum(CheckSum the checksum to set storedCheckSum) Sets the stored checksum in the ValidatingVisitor in case the changeset was executed.
public void	setStoredFilePath(String storedFilePath)
private Executor	setupCustomExecutorIfNecessary(Database database)
public void	setValidationFailed(boolean validationFailed)
public boolean	shouldAlwaysRun()
public boolean	shouldRunOnChange()
public boolean	supportsRollback(Database database)
protected Change	toChange(ParsedNode value, ResourceAccessor resourceAccessor)
public String	toNormalizedString()
public String	toString(boolean includeMD5Sum)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

public Class ChangeSet

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary