fr.ifremer.adagio.core.dao.technical.liquibase

Class Liquibase

Object

Liquibase

All Implemented Interfaces:

Aware, BeanNameAware, InitializingBean, ResourceLoaderAware

@Component(value="liquibase")
@Lazy
public class Liquibase
extends Object
implements InitializingBean, BeanNameAware, ResourceLoaderAware

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Liquibase.SpringResourceOpener

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CHANGE_LOG_SNAPSHOT_SUFFIX
protected Version	maxChangeLogFileVersion

Constructor Summary

Constructors

Constructor and Description
Liquibase(DataSource dataSource, AdagioConfiguration config)

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet() Executed automatically when the bean is initialized.
protected void	computeMaxChangeLogFileVersion()
protected Database	createDatabase(Connection c) Subclasses may override this method add change some database settings such as default schema before returning the database object.
protected Database	createHibernateDatabase() Create a database connection to hibernate model.
protected Liquibase	createLiquibase(Connection c)
protected Liquibase.SpringResourceOpener	createResourceOpener() Create a new resourceOpener.
void	executeUpdate() Execute liquibase update, using change log
void	generateDiffChangelog(File changeLogFile, String typesToControl) Generate a changelog file, with all diff found
String	getBeanName()
String	getChangeLog()
String	getContexts()
String	getDatabaseProductName()
DataSource	getDataSource()
String	getDefaultSchema()
protected Logger	getLog()
Version	getMaxChangeLogFileVersion() Get the max version from all change log files.
ResourceLoader	getResourceLoader()
protected DiffResult	performDiff(Liquibase liquibase, String typesToControl)
protected void	performReportStatus(Liquibase liquibase, Writer writer)
protected void	performUpdate(Liquibase liquibase)
void	reportDiff(File outputFile, String typesToControl) Generate a diff report (using text format)
void	reportStatus(Writer writer) Execute liquibase status, using change log
void	setBeanName(String name) Spring sets this automatically to the instance's configured bean name.
void	setChangeLog(String dataModel) Sets a Spring Resource that is able to resolve to a file or classpath resource.
void	setChangeLogParameters(Map<String,String> parameters)
void	setContexts(String contexts)
void	setDataSource(DataSource dataSource) The DataSource that liquibase will use to perform the migration.
void	setDefaultSchema(String defaultSchema)
void	setResourceLoader(ResourceLoader resourceLoader)
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CHANGE_LOG_SNAPSHOT_SUFFIX

protected static final String CHANGE_LOG_SNAPSHOT_SUFFIX

See Also:

Constant Field Values

maxChangeLogFileVersion

protected Version maxChangeLogFileVersion

Constructor Detail

Liquibase

@Autowired
public Liquibase(DataSource dataSource,
                   AdagioConfiguration config)

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws LiquibaseException

Executed automatically when the bean is initialized.

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

LiquibaseException

getDatabaseProductName

public String getDatabaseProductName()
                              throws DatabaseException

Throws:

DatabaseException

getDataSource

public DataSource getDataSource()

Returns:

The DataSource that liquibase will use to perform the migration.

setDataSource

public void setDataSource(DataSource dataSource)

The DataSource that liquibase will use to perform the migration.

getChangeLog

public String getChangeLog()

Returns:

a Resource that is able to resolve to a file or classpath resource.

setChangeLog

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.

getContexts

public String getContexts()

setContexts

public void setContexts(String contexts)

getDefaultSchema

public String getDefaultSchema()

setDefaultSchema

public void setDefaultSchema(String defaultSchema)

executeUpdate

public void executeUpdate()
                   throws LiquibaseException

Execute liquibase update, using change log

Throws:

LiquibaseException

performUpdate

protected void performUpdate(Liquibase liquibase)
                      throws LiquibaseException

Throws:

LiquibaseException

reportStatus

public void reportStatus(Writer writer)
                  throws LiquibaseException

Execute liquibase status, using change log

Throws:

LiquibaseException

performReportStatus

protected void performReportStatus(Liquibase liquibase,
                       Writer writer)
                            throws LiquibaseException

Throws:

LiquibaseException

createLiquibase

protected Liquibase createLiquibase(Connection c)
                             throws LiquibaseException

Throws:

LiquibaseException

createDatabase

protected Database createDatabase(Connection c)
                           throws DatabaseException

Subclasses may override this method add change some database settings such as default schema before returning the database object.

Parameters:

c -

Returns:

a Database implementation retrieved from the DatabaseFactory.

Throws:

DatabaseException

createHibernateDatabase

protected Database createHibernateDatabase()
                                    throws DatabaseException

Create a database connection to hibernate model. This is useful for diff report

Throws:

DatabaseException

setChangeLogParameters

public void setChangeLogParameters(Map<String,String> parameters)

createResourceOpener

protected Liquibase.SpringResourceOpener createResourceOpener()

Create a new resourceOpener.

setBeanName

public void setBeanName(String name)

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

Specified by:

setBeanName in interface BeanNameAware

getBeanName

public String getBeanName()

Returns:

the Spring-name of this instance.

setResourceLoader

public void setResourceLoader(ResourceLoader resourceLoader)

Specified by:

setResourceLoader in interface ResourceLoaderAware

getResourceLoader

public ResourceLoader getResourceLoader()

toString

public String toString()

Overrides:

toString in class Object

computeMaxChangeLogFileVersion

protected void computeMaxChangeLogFileVersion()

getMaxChangeLogFileVersion

public Version getMaxChangeLogFileVersion()

Get the max version from all change log files. change log file with version must have a same pattern as the master changelog

Returns:

the max version founded in files, or null if version found

reportDiff

public void reportDiff(File outputFile,
              String typesToControl)
                throws LiquibaseException

Generate a diff report (using text format)

Parameters:

outputFile -

typesToControl - a comma separated database object to check (i.e Table, View, Column...). If null, all types are checked

Throws:

LiquibaseException

generateDiffChangelog

public void generateDiffChangelog(File changeLogFile,
                         String typesToControl)
                           throws LiquibaseException

Generate a changelog file, with all diff found

Parameters:

changeLogFile -

typesToControl - a comma separated database object to check (i.e Table, View, Column...). If null, all types are checked

Throws:

LiquibaseException

performDiff

protected DiffResult performDiff(Liquibase liquibase,
                     String typesToControl)
                          throws LiquibaseException

Parameters:

liquibase - the connection to the target database

typesToControl - a comma separated database object to check (i.e Table, View, Column...). If null, all types are checked

Returns:

the diff result

Throws:

LiquibaseException

getLog

protected Logger getLog()