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 liquibase.database.Database	database
static java.lang.String	SHOULD_RUN_SYSTEM_PROPERTY

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	changeLogSync(java.lang.String contexts)
void	changeLogSync(java.lang.String contexts, java.io.Writer output)
void	checkDatabaseChangeLogTable(boolean updateExistingNullChecksums, liquibase.changelog.DatabaseChangeLog databaseChangeLog, java.lang.String contexts)
void	clearCheckSums() Sets checksums to null so they will be repopulated next run
liquibase.diff.Diff	diff(liquibase.database.Database referenceDatabase, liquibase.database.Database targetDatabase)
void	dropAll() Drops all database objects owned by the current user.
void	dropAll(java.lang.String... schemas) Drops all database objects owned by the current user.
void	forceReleaseLocks()
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)
liquibase.changelog.ChangeLogParameters	getChangeLogParameters()
liquibase.database.Database	getDatabase()
liquibase.resource.ResourceAccessor	getFileOpener() FileOpener to use for accessing changelog files.
boolean	isSafeToRunMigration() Returns true if it is "save" to migrate the database.
liquibase.lockservice.DatabaseChangeLogLock[]	listLocks() Display change log lock information.
java.util.List<liquibase.changelog.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	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	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	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

database

protected liquibase.database.Database database

Constructor Detail

Liquibase

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

Throws:

liquibase.exception.LiquibaseException

Liquibase

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

Throws:

liquibase.exception.LiquibaseException

Method Detail

getChangeLogParameters

public liquibase.changelog.ChangeLogParameters getChangeLogParameters()

getDatabase

public liquibase.database.Database getDatabase()

getFileOpener

public liquibase.resource.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 liquibase.exception.LiquibaseException

Throws:

liquibase.exception.LiquibaseException

update

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

Throws:

liquibase.exception.LiquibaseException

update

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

Throws:

liquibase.exception.LiquibaseException

update

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

Throws:

liquibase.exception.LiquibaseException

rollback

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

Throws:

liquibase.exception.LiquibaseException

rollback

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

Throws:

liquibase.exception.LiquibaseException

rollback

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

Throws:

liquibase.exception.LiquibaseException

rollback

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

Throws:

liquibase.exception.LiquibaseException

rollback

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

Throws:

liquibase.exception.LiquibaseException

rollback

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

Throws:

liquibase.exception.LiquibaseException

changeLogSync

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

Throws:

liquibase.exception.LiquibaseException

changeLogSync

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

Throws:

liquibase.exception.LiquibaseException

markNextChangeSetRan

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

Throws:

liquibase.exception.LiquibaseException

markNextChangeSetRan

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

Throws:

liquibase.exception.LiquibaseException

futureRollbackSQL

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

Throws:

liquibase.exception.LiquibaseException

dropAll

public final void dropAll()
                   throws liquibase.exception.DatabaseException,
                          liquibase.exception.LockException

Drops all database objects owned by the current user.

Throws:

liquibase.exception.DatabaseException

liquibase.exception.LockException

dropAll

public final void dropAll(java.lang.String... schemas)
                   throws liquibase.exception.DatabaseException

Drops all database objects owned by the current user.

Throws:

liquibase.exception.DatabaseException

tag

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

'Tags' the database for future rollback

Throws:

liquibase.exception.LiquibaseException

updateTestingRollback

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

Throws:

liquibase.exception.LiquibaseException

checkDatabaseChangeLogTable

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

Throws:

liquibase.exception.LiquibaseException

isSafeToRunMigration

public boolean isSafeToRunMigration()
                             throws liquibase.exception.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:

liquibase.exception.DatabaseException

listLocks

public liquibase.lockservice.DatabaseChangeLogLock[] listLocks()
                                                        throws liquibase.exception.LiquibaseException

Display change log lock information.

Throws:

liquibase.exception.LiquibaseException

reportLocks

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

Throws:

liquibase.exception.LiquibaseException

forceReleaseLocks

public void forceReleaseLocks()
                       throws liquibase.exception.LiquibaseException

Throws:

liquibase.exception.LiquibaseException

listUnrunChangeSets

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

Throws:

liquibase.exception.LiquibaseException

reportStatus

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

Throws:

liquibase.exception.LiquibaseException

clearCheckSums

public void clearCheckSums()
                    throws liquibase.exception.LiquibaseException

Sets checksums to null so they will be repopulated next run

Throws:

liquibase.exception.LiquibaseException

generateDocumentation

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

Throws:

liquibase.exception.LiquibaseException

generateDocumentation

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

Throws:

liquibase.exception.LiquibaseException

diff

public liquibase.diff.Diff diff(liquibase.database.Database referenceDatabase,
                       liquibase.database.Database targetDatabase)

validate

public void validate()
              throws liquibase.exception.LiquibaseException

Checks changelogs for bad MD5Sums and preconditions before attempting a migration

Throws:

liquibase.exception.LiquibaseException

setChangeLogParameter

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