Liquibase 4.26.0 · liquibase.integration.spring.SpringLiquibase

Modifier and Type	Field and Description
protected String	beanName
protected String	changeLog
protected boolean	clearCheckSums
protected String	contexts
protected String	databaseChangeLogLockTable
protected String	databaseChangeLogTable
protected DataSource	dataSource
protected String	defaultSchema
protected boolean	dropFirst
protected String	labelFilter
protected String	liquibaseSchema
protected String	liquibaseTablespace
protected final Logger	log
protected Map<String, String>	parameters
protected ResourceLoader	resourceLoader
protected File	rollbackFile
protected boolean	shouldRun
protected UpdateSummaryEnum	showSummary
protected UpdateSummaryOutputEnum	showSummaryOutput
protected String	tag
protected boolean	testRollbackOnUpdate
protected UIServiceEnum	uiService

Access	Constructor and Description
public	SpringLiquibase()

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Executed automatically when the bean is initialized.
protected Database	Returns: a Database implementation retrieved from the `DatabaseFactory` createDatabase(Connection the connection to the database c, ResourceAccessor resourceAccessor) Subclasses may override this method to modify the database settings, such as the default schema, before returning the database object.
protected Liquibase	createLiquibase(Connection c)
protected SpringResourceAccessor	createResourceOpener() Create a new resourceOpener.
private void	generateRollbackFile(Liquibase liquibase)
public String	getBeanName() Gets the Spring-name of this instance.
public String	getChangeLog() Returns a Resource that is able to resolve to a file or classpath resource.
public String	getContexts()
public String	getDatabaseChangeLogLockTable()
public String	getDatabaseChangeLogTable()
public String	getDatabaseProductName()
public DataSource	getDataSource() The DataSource that liquibase will use to perform the migration.
public String	getDefaultSchema()
public String	getLabelFilter()
public String	getLabels() Deprecated use `getLabelFilter()`
public String	getLiquibaseSchema()
public String	getLiquibaseTablespace()
public ResourceLoader	getResourceLoader()
public String	getTag()
public UIServiceEnum	getUiService()
public boolean	isClearCheckSums()
public boolean	isDropFirst()
public boolean	isIgnoreClasspathPrefix()
public boolean	isTestRollbackOnUpdate() Returns whether a rollback should be tested at update time or not.
protected void	performUpdate(Liquibase liquibase)
public void	setBeanName(String the name of the bean in the factory. Note that this name is the actual bean name used in the factory, which may differ from the originally specified name: in particular for inner bean names, the actual bean name might have been made unique through appending "#..." suffixes. Use the `BeanFactoryUtils#originalBeanName(String)` method to extract the original bean name (without suffix), if desired. name) Implements org.springframework.beans.factory.BeanNameAware.setBeanName. Spring sets this automatically to the instance's configured bean name.
public void	setChangeLog(String dataModel) Sets a Spring Resource that is able to resolve to a file or classpath resource.
public void	setChangeLogParameters(Map<String, String> parameters)
public void	setClearCheckSums(boolean clearCheckSums)
public void	setContexts(String contexts)
public void	setDatabaseChangeLogLockTable(String databaseChangeLogLockTable)
public void	setDatabaseChangeLogTable(String databaseChangeLogTable)
public void	setDataSource(DataSource dataSource) The DataSource that liquibase will use to perform the migration.
public void	setDefaultSchema(String defaultSchema)
public void	setDropFirst(boolean dropFirst)
public void	setIgnoreClasspathPrefix(boolean ignoreClasspathPrefix) Deprecated Always ignoring classpath prefix
public void	setLabelFilter(String labelFilter)
public void	setLabels(String labels) Deprecated use `setLabelFilter(String)`
public void	setLiquibaseSchema(String liquibaseSchema)
public void	setLiquibaseTablespace(String liquibaseTablespace)
public void	setResourceLoader(ResourceLoader the ResourceLoader object to be used by this object resourceLoader) Implements org.springframework.context.ResourceLoaderAware.setResourceLoader. Set the ResourceLoader that this object runs in. This might be a ResourcePatternResolver, which can be checked through `instanceof ResourcePatternResolver`.
public void	setRollbackFile(File rollbackFile)
public void	setShouldRun(boolean shouldRun)
public void	setShowSummary(UpdateSummaryEnum showSummary)
public void	setShowSummaryOutput(UpdateSummaryOutputEnum showSummaryOutput)
public void	setTag(String tag)
public void	setTestRollbackOnUpdate(boolean testRollbackOnUpdate) If testRollbackOnUpdate is set to true a rollback will be tested at update time.
public void	setUiService(UIServiceEnum uiService)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

beanName	back to summary
protected String beanName

changeLog	back to summary
protected String changeLog

clearCheckSums	back to summary
protected boolean clearCheckSums

contexts	back to summary
protected String contexts

databaseChangeLogLockTable	back to summary
protected String databaseChangeLogLockTable

databaseChangeLogTable	back to summary
protected String databaseChangeLogTable

dataSource	back to summary
protected DataSource dataSource

defaultSchema	back to summary
protected String defaultSchema

dropFirst	back to summary
protected boolean dropFirst

labelFilter	back to summary
protected String labelFilter

liquibaseSchema	back to summary
protected String liquibaseSchema

liquibaseTablespace	back to summary
protected String liquibaseTablespace

log	back to summary
protected final Logger log

parameters	back to summary
protected Map<String, String> parameters

resourceLoader	back to summary
protected ResourceLoader resourceLoader

rollbackFile	back to summary
protected File rollbackFile

shouldRun	back to summary
protected boolean shouldRun

showSummary	back to summary
protected UpdateSummaryEnum showSummary

showSummaryOutput	back to summary
protected UpdateSummaryOutputEnum showSummaryOutput

tag	back to summary
protected String tag

testRollbackOnUpdate	back to summary
protected boolean testRollbackOnUpdate

uiService	back to summary
protected UIServiceEnum uiService

SpringLiquibase	back to summary
public SpringLiquibase()

Method Detail

afterPropertiesSet	back to summary
public void afterPropertiesSet() throws LiquibaseException Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Executed automatically when the bean is initialized. Annotations @Override

afterPropertiesSet

back to summary

public void afterPropertiesSet() throws LiquibaseException

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Executed automatically when the bean is initialized.

Annotations

@Override

createDatabase back to summary

createDatabase	back to summary
protected Database createDatabase(Connection c, ResourceAccessor resourceAccessor) throws DatabaseException Subclasses may override this method to modify the database settings, such as the default schema, before returning the database object. Parameters c:Connection the connection to the database Returns:Database a Database implementation retrieved from the `DatabaseFactory` Exceptions DatabaseException: if there is an error retrieving the database implementation

protected Database createDatabase(Connection c, ResourceAccessor resourceAccessor) throws DatabaseException

Subclasses may override this method to modify the database settings, such as the default schema, before returning the database object.

Parameters

c:Connection: the connection to the database

Returns:Database

a Database implementation retrieved from the DatabaseFactory

Exceptions

DatabaseException:: if there is an error retrieving the database implementation

createLiquibase	back to summary
protected Liquibase createLiquibase(Connection c) throws LiquibaseException Annotations @SuppressWarnings:squid:S2095

createResourceOpener	back to summary
protected SpringResourceAccessor createResourceOpener() Create a new resourceOpener.

generateRollbackFile	back to summary
private void generateRollbackFile(Liquibase liquibase) throws LiquibaseException

getBeanName	back to summary
public String getBeanName() Gets the Spring-name of this instance.

getChangeLog	back to summary
public String getChangeLog() Returns a Resource that is able to resolve to a file or classpath resource.

getContexts	back to summary
public String getContexts()

getDatabaseChangeLogLockTable	back to summary
public String getDatabaseChangeLogLockTable()

getDatabaseChangeLogTable	back to summary
public String getDatabaseChangeLogTable()

getDatabaseProductName	back to summary
public String getDatabaseProductName() throws DatabaseException Annotations @SuppressWarnings:squid:S2095

getDataSource	back to summary
public DataSource getDataSource() The DataSource that liquibase will use to perform the migration.

getDefaultSchema	back to summary
public String getDefaultSchema()

getLabelFilter	back to summary
public String getLabelFilter()

getLabels	back to summary
public String getLabels() Deprecated use `getLabelFilter()`

getLiquibaseSchema	back to summary
public String getLiquibaseSchema()

getLiquibaseTablespace	back to summary
public String getLiquibaseTablespace()

getResourceLoader	back to summary
public ResourceLoader getResourceLoader()

getTag	back to summary
public String getTag()

getUiService	back to summary
public UIServiceEnum getUiService()

isClearCheckSums	back to summary
public boolean isClearCheckSums()

isDropFirst	back to summary
public boolean isDropFirst()

isIgnoreClasspathPrefix	back to summary
public boolean isIgnoreClasspathPrefix()

isTestRollbackOnUpdate	back to summary
public boolean isTestRollbackOnUpdate() Returns whether a rollback should be tested at update time or not.

performUpdate	back to summary
protected void performUpdate(Liquibase liquibase) throws LiquibaseException

setBeanName back to summary

public void setBeanName(String name)

Implements org.springframework.beans.factory.BeanNameAware.setBeanName.

Spring sets this automatically to the instance's configured bean name.

Parameters

name:String

Doc from org.springframework.beans.factory.BeanNameAware.setBeanName.

the name of the bean in the factory. Note that this name is the actual bean name used in the factory, which may differ from the originally specified name: in particular for inner bean names, the actual bean name might have been made unique through appending "#..." suffixes. Use the BeanFactoryUtils#originalBeanName(String) method to extract the original bean name (without suffix), if desired.

Annotations

@Override

setChangeLog	back to summary
public void setChangeLog(String dataModel) Sets a Spring Resource that is able to resolve to a file or classpath resource. An example might be `classpath:db-changelog.xml`.

setChangeLogParameters	back to summary
public void setChangeLogParameters(Map<String, String> parameters)

setClearCheckSums	back to summary
public void setClearCheckSums(boolean clearCheckSums)

setContexts	back to summary
public void setContexts(String contexts)

setDatabaseChangeLogLockTable	back to summary
public void setDatabaseChangeLogLockTable(String databaseChangeLogLockTable)

setDatabaseChangeLogTable	back to summary
public void setDatabaseChangeLogTable(String databaseChangeLogTable)

setDataSource	back to summary
public void setDataSource(DataSource dataSource) The DataSource that liquibase will use to perform the migration.

setDefaultSchema	back to summary
public void setDefaultSchema(String defaultSchema)

setDropFirst	back to summary
public void setDropFirst(boolean dropFirst)

setIgnoreClasspathPrefix	back to summary
public void setIgnoreClasspathPrefix(boolean ignoreClasspathPrefix) Deprecated Always ignoring classpath prefix

setLabelFilter	back to summary
public void setLabelFilter(String labelFilter)

setLabels	back to summary
public void setLabels(String labels) Deprecated use `setLabelFilter(String)`

setLiquibaseSchema	back to summary
public void setLiquibaseSchema(String liquibaseSchema)

setLiquibaseTablespace	back to summary
public void setLiquibaseTablespace(String liquibaseTablespace)

setResourceLoader back to summary

public void setResourceLoader(ResourceLoader resourceLoader)

Implements org.springframework.context.ResourceLoaderAware.setResourceLoader.

Doc from org.springframework.context.ResourceLoaderAware.setResourceLoader.

Set the ResourceLoader that this object runs in.

This might be a ResourcePatternResolver, which can be checked through instanceof ResourcePatternResolver. See also the ResourcePatternUtils.getResourcePatternResolver method.

Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked before ApplicationContextAware's setApplicationContext.

Parameters

resourceLoader:ResourceLoader: the ResourceLoader object to be used by this object

Annotations

@Override

setRollbackFile	back to summary
public void setRollbackFile(File rollbackFile)

setShouldRun	back to summary
public void setShouldRun(boolean shouldRun)

setShowSummary	back to summary
public void setShowSummary(UpdateSummaryEnum showSummary)

setShowSummaryOutput	back to summary
public void setShowSummaryOutput(UpdateSummaryOutputEnum showSummaryOutput)

setTag	back to summary
public void setTag(String tag)

setTestRollbackOnUpdate	back to summary
public void setTestRollbackOnUpdate(boolean testRollbackOnUpdate) If testRollbackOnUpdate is set to true a rollback will be tested at update time. For doing so when the update is performed

setUiService	back to summary
public void setUiService(UIServiceEnum uiService)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class SpringLiquibase

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail