liquibase

Class Liquibase

java.lang.Object

liquibase.Liquibase

public class Liquibase
extends java.lang.Object

Primary facade class for interacting with Liquibase. The built in command line, Ant, Maven and other ways of running Liquibase are wrappers around methods in 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(DatabaseChangeLog changeLog, ResourceAccessor resourceAccessor, Database database)
Liquibase(java.lang.String changeLogFile, ResourceAccessor resourceAccessor, Database database) Creates a Liquibase instance.
Liquibase(java.lang.String changeLogFile, ResourceAccessor resourceAccessor, DatabaseConnection conn) Creates a Liquibase instance for a given DatabaseConnection.

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(Contexts contexts)
void	changeLogSync(Contexts contexts, java.io.Writer output)
void	changeLogSync(java.lang.String contexts)
void	changeLogSync(java.lang.String contexts, java.io.Writer output)
void	checkLiquibaseTables(boolean updateExistingNullChecksums, DatabaseChangeLog databaseChangeLog, Contexts 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, Contexts contexts, java.io.Writer output)
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	generateChangeLog(CatalogAndSchema catalogAndSchema, DiffToChangeLog changeLogWriter, java.io.PrintStream outputStream, java.lang.Class<? extends DatabaseObject>... snapshotTypes)
void	generateDocumentation(java.lang.String outputDirectory)
void	generateDocumentation(java.lang.String outputDirectory, Contexts contexts)
void	generateDocumentation(java.lang.String outputDirectory, java.lang.String contexts)
java.lang.String	getChangeLogFile() Return the change log file used by this Liquibase instance.
ChangeLogParameters	getChangeLogParameters() Returns the ChangeLogParameters container used by this Liquibase instance.
Database	getDatabase() Returns the Database used by this Liquibase instance.
DatabaseChangeLog	getDatabaseChangeLog()
ResourceAccessor	getFileOpener() Deprecated. use the newer-terminology version getResourceAccessor()
Logger	getLog() Return the log used by this Liquibase instance.
ResourceAccessor	getResourceAccessor() Return ResourceAccessor used by this Liquibase instance.
protected ChangeLogIterator	getStandardChangelogIterator(Contexts 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(Contexts contexts)
java.util.Collection<RanChangeSet>	listUnexpectedChangeSets(java.lang.String contexts)
java.util.List<ChangeSet>	listUnrunChangeSets(Contexts contexts)
java.util.List<ChangeSet>	listUnrunChangeSets(java.lang.String contexts)
void	markNextChangeSetRan(Contexts contexts)
void	markNextChangeSetRan(Contexts contexts, java.io.Writer output)
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, Contexts contexts, java.io.Writer out)
void	reportStatus(boolean verbose, java.lang.String contexts, java.io.Writer out)
void	reportUnexpectedChangeSets(boolean verbose, Contexts contexts, java.io.Writer out)
void	reportUnexpectedChangeSets(boolean verbose, java.lang.String contexts, java.io.Writer out)
void	rollback(java.util.Date dateToRollBackTo, Contexts contexts)
void	rollback(java.util.Date dateToRollBackTo, Contexts contexts, java.io.Writer output)
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, Contexts contexts)
void	rollback(int changesToRollback, Contexts 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, Contexts contexts)
void	rollback(java.lang.String tagToRollBackTo, Contexts 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) Deprecated. Should call Database.setCurrentDateTimeFunction(String) directly
void	setIgnoreClasspathPrefix(boolean ignoreClasspathPrefix)
void	tag(java.lang.String tagString) 'Tags' the database for future rollback
void	update(Contexts contexts) Executes Liquibase "update" logic which ensures that the configured Database is up to dat according to the configured changelog file.
void	update(Contexts contexts, java.io.Writer output)
void	update(int changesToApply, Contexts contexts)
void	update(int changesToApply, Contexts contexts, java.io.Writer output)
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) Convience method for update(Contexts) that constructs the Context object from the passed string.
void	update(java.lang.String contexts, java.io.Writer output)
void	updateTestingRollback(Contexts contexts)
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

Creates a Liquibase instance for a given DatabaseConnection. The Database instance used will be found with DatabaseFactory.findCorrectDatabaseImplementation(liquibase.database.DatabaseConnection)

Throws:

LiquibaseException

See Also:

Liquibase(String, liquibase.resource.ResourceAccessor, liquibase.database.Database), ResourceAccessor

Liquibase

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

Creates a Liquibase instance. The changeLogFile parameter must be a path that can be resolved by the passed ResourceAccessor. If windows style path separators are used for the changeLogFile, they will be standardized to unix style for better cross-system compatib.

Throws:

LiquibaseException

See Also:

ResourceAccessor

Liquibase

public Liquibase(DatabaseChangeLog changeLog,
         ResourceAccessor resourceAccessor,
         Database database)

Method Detail

getChangeLogFile

public java.lang.String getChangeLogFile()

Return the change log file used by this Liquibase instance.

getLog

public Logger getLog()

Return the log used by this Liquibase instance.

getChangeLogParameters

public ChangeLogParameters getChangeLogParameters()

Returns the ChangeLogParameters container used by this Liquibase instance.

getDatabase

public Database getDatabase()

Returns the Database used by this Liquibase instance.

getFileOpener

public ResourceAccessor getFileOpener()

Deprecated. use the newer-terminology version getResourceAccessor()

Return ResourceAccessor used by this Liquibase instance.

getResourceAccessor

public ResourceAccessor getResourceAccessor()

Return ResourceAccessor used by this Liquibase instance.

setCurrentDateTimeFunction

public void setCurrentDateTimeFunction(java.lang.String currentDateTimeFunction)

Deprecated. Should call Database.setCurrentDateTimeFunction(String) directly

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

Convience method for update(Contexts) that constructs the Context object from the passed string.

Throws:

LiquibaseException

update

public void update(Contexts contexts)
            throws LiquibaseException

Executes Liquibase "update" logic which ensures that the configured Database is up to dat according to the configured changelog file. To run in "no context mode", pass a null or empty context object.

Throws:

LiquibaseException

getDatabaseChangeLog

public DatabaseChangeLog getDatabaseChangeLog()
                                       throws LiquibaseException

Throws:

LiquibaseException

createUpdateVisitor

protected UpdateVisitor createUpdateVisitor()

getStandardChangelogIterator

protected ChangeLogIterator getStandardChangelogIterator(Contexts 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(Contexts 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,
          Contexts contexts)
            throws LiquibaseException

Throws:

LiquibaseException

update

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

Throws:

LiquibaseException

update

public void update(int changesToApply,
          Contexts 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,
            Contexts 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(int changesToRollback,
            Contexts 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,
            Contexts 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.lang.String tagToRollBackTo,
            Contexts 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,
            Contexts 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

rollback

public void rollback(java.util.Date dateToRollBackTo,
            Contexts 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(Contexts contexts,
                 java.io.Writer output)
                   throws LiquibaseException

Throws:

LiquibaseException

changeLogSync

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

Throws:

LiquibaseException

changeLogSync

public void changeLogSync(Contexts 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(Contexts contexts,
                        java.io.Writer output)
                          throws LiquibaseException

Throws:

LiquibaseException

markNextChangeSetRan

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

Throws:

LiquibaseException

markNextChangeSetRan

public void markNextChangeSetRan(Contexts 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

futureRollbackSQL

public void futureRollbackSQL(java.lang.Integer count,
                     Contexts 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

updateTestingRollback

public void updateTestingRollback(Contexts contexts)
                           throws LiquibaseException

Throws:

LiquibaseException

checkLiquibaseTables

public void checkLiquibaseTables(boolean updateExistingNullChecksums,
                        DatabaseChangeLog databaseChangeLog,
                        Contexts 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

listUnrunChangeSets

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

Throws:

LiquibaseException

reportStatus

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

Throws:

LiquibaseException

reportStatus

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

Throws:

LiquibaseException

listUnexpectedChangeSets

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

Throws:

LiquibaseException

listUnexpectedChangeSets

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

Throws:

LiquibaseException

reportUnexpectedChangeSets

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

Throws:

LiquibaseException

reportUnexpectedChangeSets

public void reportUnexpectedChangeSets(boolean verbose,
                              Contexts 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

generateDocumentation

public void generateDocumentation(java.lang.String outputDirectory,
                         Contexts 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()

generateChangeLog

public void generateChangeLog(CatalogAndSchema catalogAndSchema,
                     DiffToChangeLog changeLogWriter,
                     java.io.PrintStream outputStream,
                     java.lang.Class<? extends DatabaseObject>... snapshotTypes)
                       throws DatabaseException,
                              java.io.IOException,
                              javax.xml.parsers.ParserConfigurationException

Throws:

DatabaseException

java.io.IOException

javax.xml.parsers.ParserConfigurationException