Package org.liquibase.maven.plugins

Class LiquibaseRollback

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.liquibase.maven.plugins.AbstractLiquibaseMojo

org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

org.liquibase.maven.plugins.LiquibaseRollback

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

LiquibaseFutureRollbackSQL, LiquibaseRollbackSQL

public class LiquibaseRollback
extends AbstractLiquibaseChangeLogMojo

Invokes Liquibase to rollback the database (and mark changesets as unapplied). The changesets to be rolled back are specified using attributes 'rollbackCount', 'rollbackTag' and/or 'rollbackDate'

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	LiquibaseRollback.RollbackType

Field Summary

Fields

Modifier and Type	Field	Description
protected int	rollbackCount	The number of changesets to rollback.
protected String	rollbackDate	The date to rollback the database to.
protected String	rollbackScript	External script containing rollback logic.
protected String	rollbackTag	The tag to roll the database back to.
protected LiquibaseRollback.RollbackType	type	The type of the rollback that is being performed.

Fields inherited from class org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

changeLogDirectory, changeLogFile, contexts, duplicateFileMode, labelFilter, labels

Fields inherited from class org.liquibase.maven.plugins.AbstractLiquibaseMojo

analyticsEnabled, changeExecListenerClass, changeExecListenerPropertiesFile, changelogCatalogName, changelogSchemaName, clearCheckSums, commandName, databaseChangelogHistoryCaptureExtensions, databaseChangelogHistoryCaptureSql, databaseChangelogHistoryEnabled, databaseChangeLogLockTableName, databaseChangeLogTableName, databaseClass, dbclHistoryCaptureExtensions, dbclHistoryCaptureSql, dbclHistoryEnabled, defaultCatalogName, defaultChangeExecListener, defaultSchemaName, driver, emptyPassword, includeArtifact, includeTestOutputDirectory, logFormat, logging, logLevel, mojoExecution, outputDefaultCatalog, outputDefaultSchema, outputFileEncoding, password, preserveSchemaCase, project, promptOnNonLocalDatabase, propertyFile, propertyFileWillOverride, propertyProviderClass, psqlArgs, psqlKeepTemp, psqlKeepTempName, psqlKeepTempPath, psqlLogFile, psqlPath, psqlTimeout, searchPath, session, showBanner, skip, skipOnFileExists, sqlcmdArgs, sqlcmdCatalogName, sqlcmdKeepTemp, sqlcmdKeepTempName, sqlcmdKeepTempOverwrite, sqlcmdKeepTempPath, sqlcmdLogFile, sqlcmdPath, sqlcmdTimeout, sqlPlusArgs, sqlPlusKeepTemp, sqlPlusKeepTempName, sqlPlusKeepTempOverwrite, sqlPlusKeepTempPath, sqlPlusLogFile, sqlPlusPath, sqlPlusTimeout, suppressLiquibaseSql, systemProperties, url, username, vaultAddr, vaultNamespace, vaultToken, verbose, wagonManager

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
LiquibaseRollback()

Method Summary

Modifier and Type	Method	Description
protected void	checkRequiredParametersAreSpecified()	Performs some validation after the properties file has been loaded checking that all properties required have been specified.
protected void	checkRequiredRollbackParameters()
protected Date	parseDate(String date)
protected void	performLiquibaseTask(Liquibase liquibase)	Performs the actual Liquibase task on the database using the fully configured Liquibase.
protected void	printSettings(String indent)	Prints the settings that have been set of defaulted for the plugin.

Methods inherited from class org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

createLiquibase, getLabelFilter, getResourceAccessor

Methods inherited from class org.liquibase.maven.plugins.AbstractLiquibaseMojo

cleanup, configureChangeLogProperties, configureFieldsAndValues, databaseConnectionRequired, execute, getClassLoaderIncludingProjectClasspath, getField, getLicenseKey, getLiquibase, getLog, getMavenArtifactClassLoader, getOutputStream, getOutputWriter, isPromptOnNonLocalDatabase, parsePropertiesFile, setPassword, setupBindInfoPackage, setUrl, setUsername, setVaultAddr, setVaultNamespace, setVaultToken

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Details

rollbackTag

protected String rollbackTag

The tag to roll the database back to.

rollbackCount

protected int rollbackCount

The number of changesets to rollback.

rollbackDate

protected String rollbackDate

The date to rollback the database to. The format of the date must match either an ISO date format, or that of the DateFormat.getDateInstance() for the platform the plugin is executing on.

type

protected LiquibaseRollback.RollbackType type

The type of the rollback that is being performed.

rollbackScript

protected String rollbackScript

External script containing rollback logic. Set to override the rollback logic contained in the changelog

Constructor Details

LiquibaseRollback

public LiquibaseRollback()

Method Details

checkRequiredParametersAreSpecified

protected void checkRequiredParametersAreSpecified()
                                            throws org.apache.maven.plugin.MojoFailureException

Description copied from class: AbstractLiquibaseMojo

Performs some validation after the properties file has been loaded checking that all properties required have been specified.

Overrides:

checkRequiredParametersAreSpecified in class AbstractLiquibaseChangeLogMojo

Throws:

org.apache.maven.plugin.MojoFailureException - If any property that is required has not been specified.

checkRequiredRollbackParameters

protected void checkRequiredRollbackParameters()
                                        throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

printSettings

protected void printSettings(String indent)

Description copied from class: AbstractLiquibaseMojo

Prints the settings that have been set of defaulted for the plugin. These will only be shown in verbose mode.

Overrides:

printSettings in class AbstractLiquibaseChangeLogMojo

Parameters:

indent - The indent string to use when printing the settings.

performLiquibaseTask

protected void performLiquibaseTask(Liquibase liquibase)
                             throws LiquibaseException

Description copied from class: AbstractLiquibaseChangeLogMojo

Performs the actual Liquibase task on the database using the fully configured Liquibase.

Overrides:

performLiquibaseTask in class AbstractLiquibaseChangeLogMojo

Parameters:

liquibase - The Liquibase that has been fully configured to run the desired database task.

Throws:

LiquibaseException

parseDate

protected Date parseDate(String date)
                  throws ParseException

Throws:

ParseException