liquibase

Class Liquibase

java.lang.Object

liquibase.Liquibase

public class Liquibase
extends java.lang.Object

Core Liquibase facade. Although there are several ways of executing Liquibase (Ant, command line, etc.) they are all wrappers around this class.

Field Summary

Fields

Modifier and Type	Field and Description
protected Database	database
static java.lang.String	ENABLE_CHANGELOG_PROP_ESCAPING
static java.lang.String	SHOULD_RUN_SYSTEM_PROPERTY

Constructor Summary

Constructors

Constructor and Description
Liquibase(java.lang.String changeLogFile, ResourceAccessor resourceAccessor, Database database)
Liquibase(java.lang.String changeLogFile, ResourceAccessor resourceAccessor, DatabaseConnection conn)

Method Summary

Methods

Modifier and Type	Method and Description
CheckSum	calculateCheckSum(java.lang.String changeSetIdentifier)
CheckSum	calculateCheckSum(java.lang.String filename, java.lang.String id, java.lang.String author)
void	changeLogSync(java.lang.String contexts)
void	changeLogSync(java.lang.String contexts, java.io.Writer output)
void	checkDatabaseChangeLogTable(boolean updateExistingNullChecksums, DatabaseChangeLog databaseChangeLog, java.lang.String contexts)
void	clearCheckSums() Sets checksums to null so they will be repopulated next run
protected UpdateVisitor	createUpdateVisitor()
DiffResult	diff(Database referenceDatabase, Database targetDatabase, CompareControl compareControl)
void	dropAll() Drops all database objects owned by the current user.
void	dropAll(CatalogAndSchema... schemas) Drops all database objects owned by the current user.
void	forceReleaseLocks()
void	futureRollbackSQL(java.lang.Integer count, java.lang.String contexts, java.io.Writer output)
void	futureRollbackSQL(java.lang.String contexts, java.io.Writer output)
void	generateDocumentation(java.lang.String outputDirectory)
void	generateDocumentation(java.lang.String outputDirectory, java.lang.String contexts)
ChangeLogParameters	getChangeLogParameters()
Database	getDatabase()
ResourceAccessor	getFileOpener() FileOpener to use for accessing changelog files.
protected ChangeLogIterator	getStandardChangelogIterator(java.lang.String contexts, DatabaseChangeLog changeLog)
boolean	isIgnoreClasspathPrefix()
boolean	isSafeToRunUpdate() Returns true if it is "save" to migrate the database.
DatabaseChangeLogLock[]	listLocks() Display change log lock information.
java.util.Collection<RanChangeSet>	listUnexpectedChangeSets(java.lang.String contexts)
java.util.List<ChangeSet>	listUnrunChangeSets(java.lang.String contexts)
void	markNextChangeSetRan(java.lang.String contexts)
void	markNextChangeSetRan(java.lang.String contexts, java.io.Writer output)
void	reportLocks(java.io.PrintStream out)
void	reportStatus(boolean verbose, java.lang.String contexts, java.io.Writer out)
void	reportUnexpectedChangeSets(boolean verbose, java.lang.String contexts, java.io.Writer out)
void	rollback(java.util.Date dateToRollBackTo, java.lang.String contexts)
void	rollback(java.util.Date dateToRollBackTo, java.lang.String contexts, java.io.Writer output)
void	rollback(int changesToRollback, java.lang.String contexts)
void	rollback(int changesToRollback, java.lang.String contexts, java.io.Writer output)
void	rollback(java.lang.String tagToRollBackTo, java.lang.String contexts)
void	rollback(java.lang.String tagToRollBackTo, java.lang.String contexts, java.io.Writer output)
void	setChangeExecListener(ChangeExecListener listener)
void	setChangeLogParameter(java.lang.String key, java.lang.Object value)
void	setCurrentDateTimeFunction(java.lang.String currentDateTimeFunction) Use this function to override the current date/time function used to insert dates into the database.
void	setIgnoreClasspathPrefix(boolean ignoreClasspathPrefix)
void	tag(java.lang.String tagString) 'Tags' the database for future rollback
void	update(int changesToApply, java.lang.String contexts)
void	update(int changesToApply, java.lang.String contexts, java.io.Writer output)
void	update(java.lang.String contexts)
void	update(java.lang.String contexts, java.io.Writer output)
void	updateTestingRollback(java.lang.String contexts)
void	validate() Checks changelogs for bad MD5Sums and preconditions before attempting a migration

Methods inherited from class java.lang.Object

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

Field Detail

SHOULD_RUN_SYSTEM_PROPERTY

public static final java.lang.String SHOULD_RUN_SYSTEM_PROPERTY

See Also:

Constant Field Values

ENABLE_CHANGELOG_PROP_ESCAPING

public static final java.lang.String ENABLE_CHANGELOG_PROP_ESCAPING

See Also:

Constant Field Values

database

protected Database database

Constructor Detail

Liquibase

public Liquibase(java.lang.String changeLogFile,
         ResourceAccessor resourceAccessor,
         DatabaseConnection conn)
          throws LiquibaseException

Throws:

LiquibaseException

Liquibase

public Liquibase(java.lang.String changeLogFile,
         ResourceAccessor resourceAccessor,
         Database database)
          throws LiquibaseException

Throws:

LiquibaseException

Method Detail

getChangeLogParameters

public ChangeLogParameters getChangeLogParameters()

getDatabase

public Database getDatabase()

getFileOpener

public ResourceAccessor getFileOpener()

FileOpener to use for accessing changelog files.

setCurrentDateTimeFunction

public void setCurrentDateTimeFunction(java.lang.String currentDateTimeFunction)

Use this function to override the current date/time function used to insert dates into the database. Especially useful when using an unsupported database.

update

public void update(java.lang.String contexts)
            throws LiquibaseException

Throws:

LiquibaseException

createUpdateVisitor

protected UpdateVisitor createUpdateVisitor()

getStandardChangelogIterator

protected ChangeLogIterator getStandardChangelogIterator(java.lang.String contexts,
                                             DatabaseChangeLog changeLog)
                                                  throws DatabaseException

Throws:

DatabaseException

update

public void update(java.lang.String contexts,
          java.io.Writer output)
            throws LiquibaseException

Throws:

LiquibaseException

update

public void update(int changesToApply,
          java.lang.String contexts)
            throws LiquibaseException

Throws:

LiquibaseException

update

public void update(int changesToApply,
          java.lang.String contexts,
          java.io.Writer output)
            throws LiquibaseException

Throws:

LiquibaseException

rollback

public void rollback(int changesToRollback,
            java.lang.String contexts,
            java.io.Writer output)
              throws LiquibaseException

Throws:

LiquibaseException

rollback

public void rollback(int changesToRollback,
            java.lang.String contexts)
              throws LiquibaseException

Throws:

LiquibaseException

rollback

public void rollback(java.lang.String tagToRollBackTo,
            java.lang.String contexts,
            java.io.Writer output)
              throws LiquibaseException

Throws:

LiquibaseException

rollback

public void rollback(java.lang.String tagToRollBackTo,
            java.lang.String contexts)
              throws LiquibaseException

Throws:

LiquibaseException

rollback

public void rollback(java.util.Date dateToRollBackTo,
            java.lang.String contexts,
            java.io.Writer output)
              throws LiquibaseException

Throws:

LiquibaseException

rollback

public void rollback(java.util.Date dateToRollBackTo,
            java.lang.String contexts)
              throws LiquibaseException

Throws:

LiquibaseException

changeLogSync

public void changeLogSync(java.lang.String contexts,
                 java.io.Writer output)
                   throws LiquibaseException

Throws:

LiquibaseException

changeLogSync

public void changeLogSync(java.lang.String contexts)
                   throws LiquibaseException

Throws:

LiquibaseException

markNextChangeSetRan

public void markNextChangeSetRan(java.lang.String contexts,
                        java.io.Writer output)
                          throws LiquibaseException

Throws:

LiquibaseException

markNextChangeSetRan

public void markNextChangeSetRan(java.lang.String contexts)
                          throws LiquibaseException

Throws:

LiquibaseException

futureRollbackSQL

public void futureRollbackSQL(java.lang.String contexts,
                     java.io.Writer output)
                       throws LiquibaseException

Throws:

LiquibaseException

futureRollbackSQL

public void futureRollbackSQL(java.lang.Integer count,
                     java.lang.String contexts,
                     java.io.Writer output)
                       throws LiquibaseException

Throws:

LiquibaseException

dropAll

public final void dropAll()
                   throws DatabaseException,
                          LockException

Drops all database objects owned by the current user.

Throws:

DatabaseException

LockException

dropAll

public final void dropAll(CatalogAndSchema... schemas)
                   throws DatabaseException

Drops all database objects owned by the current user.

Throws:

DatabaseException

tag

public void tag(java.lang.String tagString)
         throws LiquibaseException

'Tags' the database for future rollback

Throws:

LiquibaseException

updateTestingRollback

public void updateTestingRollback(java.lang.String contexts)
                           throws LiquibaseException

Throws:

LiquibaseException

checkDatabaseChangeLogTable

public void checkDatabaseChangeLogTable(boolean updateExistingNullChecksums,
                               DatabaseChangeLog databaseChangeLog,
                               java.lang.String contexts)
                                 throws LiquibaseException

Throws:

LiquibaseException

isSafeToRunUpdate

public boolean isSafeToRunUpdate()
                          throws DatabaseException

Returns true if it is "save" to migrate the database. Currently, "safe" is defined as running in an output-sql mode or against a database on localhost. It is fine to run Liquibase against a "non-safe" database, the method is mainly used to determine if the user should be prompted before continuing.

Throws:

DatabaseException

listLocks

public DatabaseChangeLogLock[] listLocks()
                                  throws LiquibaseException

Display change log lock information.

Throws:

LiquibaseException

reportLocks

public void reportLocks(java.io.PrintStream out)
                 throws LiquibaseException

Throws:

LiquibaseException

forceReleaseLocks

public void forceReleaseLocks()
                       throws LiquibaseException

Throws:

LiquibaseException

listUnrunChangeSets

public java.util.List<ChangeSet> listUnrunChangeSets(java.lang.String contexts)
                                              throws LiquibaseException

Throws:

LiquibaseException

reportStatus

public void reportStatus(boolean verbose,
                java.lang.String contexts,
                java.io.Writer out)
                  throws LiquibaseException

Throws:

LiquibaseException

listUnexpectedChangeSets

public java.util.Collection<RanChangeSet> listUnexpectedChangeSets(java.lang.String contexts)
                                                            throws LiquibaseException

Throws:

LiquibaseException

reportUnexpectedChangeSets

public void reportUnexpectedChangeSets(boolean verbose,
                              java.lang.String contexts,
                              java.io.Writer out)
                                throws LiquibaseException

Throws:

LiquibaseException

clearCheckSums

public void clearCheckSums()
                    throws LiquibaseException

Sets checksums to null so they will be repopulated next run

Throws:

LiquibaseException

calculateCheckSum

public final CheckSum calculateCheckSum(java.lang.String changeSetIdentifier)
                                 throws LiquibaseException

Throws:

LiquibaseException

calculateCheckSum

public CheckSum calculateCheckSum(java.lang.String filename,
                         java.lang.String id,
                         java.lang.String author)
                           throws LiquibaseException

Throws:

LiquibaseException

generateDocumentation

public void generateDocumentation(java.lang.String outputDirectory)
                           throws LiquibaseException

Throws:

LiquibaseException

generateDocumentation

public void generateDocumentation(java.lang.String outputDirectory,
                         java.lang.String contexts)
                           throws LiquibaseException

Throws:

LiquibaseException

diff

public DiffResult diff(Database referenceDatabase,
              Database targetDatabase,
              CompareControl compareControl)
                throws LiquibaseException

Throws:

LiquibaseException

validate

public void validate()
              throws LiquibaseException

Checks changelogs for bad MD5Sums and preconditions before attempting a migration

Throws:

LiquibaseException

setChangeLogParameter

public void setChangeLogParameter(java.lang.String key,
                         java.lang.Object value)

setChangeExecListener

public void setChangeExecListener(ChangeExecListener listener)

setIgnoreClasspathPrefix

public void setIgnoreClasspathPrefix(boolean ignoreClasspathPrefix)

isIgnoreClasspathPrefix

public boolean isIgnoreClasspathPrefix()