liquibase.integration.spring.SpringLiquibase Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of liquibase-core Show documentation
Show all versions of liquibase-core Show documentation
Liquibase is a tool for managing and executing database changes.
The newest version!
package liquibase.integration.spring;
import liquibase.*;
import liquibase.configuration.ConfiguredValue;
import liquibase.database.Database;
import liquibase.database.DatabaseConnection;
import liquibase.database.DatabaseFactory;
import liquibase.database.OfflineConnection;
import liquibase.database.core.DerbyDatabase;
import liquibase.database.jvm.JdbcConnection;
import liquibase.exception.DatabaseException;
import liquibase.exception.LiquibaseException;
import liquibase.exception.UnexpectedLiquibaseException;
import liquibase.integration.IntegrationDetails;
import liquibase.integration.commandline.LiquibaseCommandLineConfiguration;
import liquibase.logging.Logger;
import liquibase.resource.ResourceAccessor;
import liquibase.structure.core.Catalog;
import liquibase.structure.core.Schema;
import liquibase.ui.UIServiceEnum;
import liquibase.util.StringUtil;
import lombok.Getter;
import lombok.Setter;
import org.springframework.beans.factory.BeanNameAware;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.context.ResourceLoaderAware;
import org.springframework.core.io.ResourceLoader;
import javax.sql.DataSource;
import java.io.*;
import java.nio.file.Files;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
/**
* A Spring-ified wrapper for Liquibase.
*
* Example Configuration:
*
*
* This Spring configuration example will cause liquibase to run automatically when the Spring context is
* initialized. It will load db-changelog.xml from the classpath and apply it against
* myDataSource.
*
*
*
*
* <bean id="myLiquibase"
* class="liquibase.spring.SpringLiquibase"
* >
*
* <property name="dataSource" ref="myDataSource" />
*
* <property name="changeLog" value="classpath:db-changelog.xml" />
*
* </bean>
*
*
*
* @author Rob Schoening
*/
public class SpringLiquibase implements InitializingBean, BeanNameAware, ResourceLoaderAware {
protected final Logger log = Scope.getCurrentScope().getLog(SpringLiquibase.class);
protected String beanName;
@Getter
@Setter
protected ResourceLoader resourceLoader;
protected DataSource dataSource;
protected String changeLog;
@Getter
@Setter
protected String contexts;
@Getter
@Setter
protected String labelFilter;
@Getter
@Setter
protected String tag;
protected Map parameters;
@Getter
@Setter
protected String defaultSchema;
@Getter
@Setter
protected String liquibaseSchema;
@Getter
@Setter
protected String databaseChangeLogTable;
@Getter
@Setter
protected String databaseChangeLogLockTable;
@Getter
@Setter
protected String liquibaseTablespace;
@Getter
@Setter
protected boolean dropFirst;
@Getter
@Setter
protected boolean clearCheckSums;
@Setter
protected boolean shouldRun = true;
@Setter
protected File rollbackFile;
@Setter
protected UpdateSummaryEnum showSummary;
protected UpdateSummaryOutputEnum showSummaryOutput = UpdateSummaryOutputEnum.LOG;
protected boolean testRollbackOnUpdate = false;
@Getter
protected UIServiceEnum uiService = UIServiceEnum.LOGGER;
@Getter
@Setter
protected Customizer customizer;
public SpringLiquibase() {
super();
}
@java.lang.SuppressWarnings("squid:S2095")
public String getDatabaseProductName() throws DatabaseException {
Connection connection = null;
Database database = null;
String name = "unknown";
try {
connection = getDataSource().getConnection();
database = DatabaseFactory.getInstance().findCorrectDatabaseImplementation(new JdbcConnection(connection));
name = database.getDatabaseProductName();
} catch (SQLException e) {
throw new DatabaseException(e);
} finally {
if (database != null) {
database.close();
} else {
if (connection != null) {
try {
if (!connection.getAutoCommit()) {
connection.rollback();
}
connection.close();
} catch (SQLException e) {
log.warning("problem closing connection", e);
}
}
}
}
return name;
}
/**
* The DataSource that liquibase will use to perform the migration.
*/
public DataSource getDataSource() {
return dataSource;
}
/**
* The DataSource that liquibase will use to perform the migration.
*/
public void setDataSource(DataSource dataSource) {
this.dataSource = dataSource;
}
/**
* Returns a Resource that is able to resolve to a file or classpath resource.
*/
public String getChangeLog() {
return changeLog;
}
/**
* Sets a Spring Resource that is able to resolve to a file or classpath resource.
* An example might be classpath:db-changelog.xml.
*/
public void setChangeLog(String dataModel) {
this.changeLog = dataModel;
}
/**
* @deprecated use {@link #getLabelFilter()}
*/
@Deprecated
public String getLabels() {
return getLabelFilter();
}
/**
* @deprecated use {@link #setLabelFilter(String)}
*/
@Deprecated
public void setLabels(String labels) {
setLabelFilter(labels);
}
/**
* Returns whether a rollback should be tested at update time or not.
*/
public boolean isTestRollbackOnUpdate() {
return testRollbackOnUpdate;
}
/**
* If testRollbackOnUpdate is set to true a rollback will be tested at update time.
* For doing so when the update is performed
*
* @param testRollbackOnUpdate
*/
public void setTestRollbackOnUpdate(boolean testRollbackOnUpdate) {
this.testRollbackOnUpdate = testRollbackOnUpdate;
}
/**
* Executed automatically when the bean is initialized.
*/
@Override
public void afterPropertiesSet() throws LiquibaseException {
final ConfiguredValue shouldRunProperty = LiquibaseCommandLineConfiguration.SHOULD_RUN.getCurrentConfiguredValue();
if (!(Boolean) shouldRunProperty.getValue()) {
Scope.getCurrentScope().getLog(getClass()).info("Liquibase did not run because " + shouldRunProperty.getProvidedValue().describe() + " was set to false");
return;
}
if (!shouldRun) {
Scope.getCurrentScope().getLog(getClass()).info("Liquibase did not run because 'shouldRun' " + "property was set " +
"to false on " + getBeanName() + " Liquibase Spring bean.");
return;
}
try {
Map scopeVars = new HashMap<>();
scopeVars.put(Scope.Attr.ui.name(), this.uiService.getUiServiceClass().getDeclaredConstructor().newInstance());
scopeVars.put(Scope.Attr.integrationDetails.name(), new IntegrationDetails("spring"));
Scope.child(scopeVars,
() -> {
Liquibase liquibase = null;
try {
final Connection c = getDataSource().getConnection();
liquibase = createLiquibase(c);
generateRollbackFile(liquibase);
performUpdate(liquibase);
} catch (SQLException e) {
throw new DatabaseException(e);
} finally {
if (liquibase != null) {
liquibase.close();
}
}
});
} catch (Exception e) {
throw new LiquibaseException(e);
}
}
private void generateRollbackFile(Liquibase liquibase) throws LiquibaseException {
if (rollbackFile != null) {
try (
final OutputStream outputStream = Files.newOutputStream(rollbackFile.toPath());
Writer output = new OutputStreamWriter(outputStream, GlobalConfiguration.OUTPUT_FILE_ENCODING.getCurrentValue())) {
if (tag != null) {
liquibase.futureRollbackSQL(tag, new Contexts(getContexts()),
new LabelExpression(getLabelFilter()), output);
} else {
liquibase.futureRollbackSQL(new Contexts(getContexts()), new LabelExpression(getLabelFilter()), output);
}
} catch (IOException e) {
throw new LiquibaseException("Unable to generate rollback file.", e);
}
}
}
protected void performUpdate(Liquibase liquibase) throws LiquibaseException {
if (isClearCheckSums()) {
liquibase.clearCheckSums();
}
if (isTestRollbackOnUpdate()) {
if (tag != null) {
liquibase.updateTestingRollback(tag, new Contexts(getContexts()), new LabelExpression(getLabelFilter()));
} else {
liquibase.updateTestingRollback(new Contexts(getContexts()), new LabelExpression(getLabelFilter()));
}
} else {
if (tag != null) {
liquibase.update(tag, new Contexts(getContexts()), new LabelExpression(getLabelFilter()));
} else {
liquibase.update(new Contexts(getContexts()), new LabelExpression(getLabelFilter()));
}
}
}
@java.lang.SuppressWarnings("squid:S2095")
protected Liquibase createLiquibase(Connection c) throws LiquibaseException {
SpringResourceAccessor resourceAccessor = createResourceOpener();
Liquibase liquibase = new Liquibase(getChangeLog(), resourceAccessor, createDatabase(c, resourceAccessor));
if (parameters != null) {
for (Map.Entry entry : parameters.entrySet()) {
liquibase.setChangeLogParameter(entry.getKey(), entry.getValue());
}
}
if (isDropFirst()) {
liquibase.dropAll();
}
liquibase.setShowSummaryOutput(showSummaryOutput);
liquibase.setShowSummary(showSummary);
if (liquibase.getDatabase() instanceof DerbyDatabase) {
((DerbyDatabase) liquibase.getDatabase()).setShutdownEmbeddedDerby(false);
}
if (customizer != null) {
customizer.customize(liquibase);
}
return liquibase;
}
/**
* Subclasses may override this method to modify the database settings, such as the default schema, before returning the database object.
*
* @param c the connection to the database
* @return a Database implementation retrieved from the {@link DatabaseFactory}
* @throws DatabaseException if there is an error retrieving the database implementation
*/
protected Database createDatabase(Connection c, ResourceAccessor resourceAccessor) throws DatabaseException {
DatabaseConnection liquibaseConnection;
if (c == null) {
log.warning("Null connection returned by liquibase datasource. Using offline unknown database");
liquibaseConnection = new OfflineConnection("offline:unknown", resourceAccessor);
} else {
liquibaseConnection = new JdbcConnection(c);
}
Database database = DatabaseFactory.getInstance().findCorrectDatabaseImplementation(liquibaseConnection);
if (StringUtil.trimToNull(this.defaultSchema) != null) {
if (database.supports(Schema.class)) {
database.setDefaultSchemaName(this.defaultSchema);
} else if (database.supports(Catalog.class)) {
database.setDefaultCatalogName(this.defaultSchema);
}
}
if (StringUtil.trimToNull(this.liquibaseSchema) != null) {
if (database.supports(Schema.class)) {
database.setLiquibaseSchemaName(this.liquibaseSchema);
} else if (database.supports(Catalog.class)) {
database.setLiquibaseCatalogName(this.liquibaseSchema);
}
}
if (StringUtil.trimToNull(this.liquibaseTablespace) != null && database.supportsTablespaces()) {
database.setLiquibaseTablespaceName(this.liquibaseTablespace);
}
if (StringUtil.trimToNull(this.databaseChangeLogTable) != null) {
database.setDatabaseChangeLogTableName(this.databaseChangeLogTable);
}
if (StringUtil.trimToNull(this.databaseChangeLogLockTable) != null) {
database.setDatabaseChangeLogLockTableName(this.databaseChangeLogLockTable);
}
return database;
}
public void setChangeLogParameters(Map parameters) {
this.parameters = parameters;
}
/**
* Create a new resourceOpener.
*/
protected SpringResourceAccessor createResourceOpener() {
return new SpringResourceAccessor(resourceLoader);
}
/**
* Gets the Spring-name of this instance.
*
* @return
*/
public String getBeanName() {
return beanName;
}
/**
* Spring sets this automatically to the instance's configured bean name.
*/
@Override
public void setBeanName(String name) {
this.beanName = name;
}
public void setShowSummaryOutput(UpdateSummaryOutputEnum showSummaryOutput) {
if (showSummaryOutput == null) {
return;
}
this.showSummaryOutput = showSummaryOutput;
}
public void setUiService(UIServiceEnum uiService) {
if (uiService == null) {
return;
}
this.uiService = uiService;
}
@Override
public String toString() {
return getClass().getName() + "(" + this.getResourceLoader().toString() + ")";
}
}