org.liquibase.maven.plugins

Class AbstractLiquibaseUpdateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.liquibase.maven.plugins.AbstractLiquibaseMojo

org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

org.liquibase.maven.plugins.AbstractLiquibaseUpdateMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

LiquibaseMigrate, LiquibaseMigrateSQL, LiquibaseUpdate, LiquibaseUpdateSQL, LiquibaseUpdateTestingRollback

public abstract class AbstractLiquibaseUpdateMojo
extends AbstractLiquibaseChangeLogMojo

Liquibase Update Maven plugin. This plugin allows for DatabaseChangeLogs to be applied to a database as part of a Maven build process.

Author:

Peter Murray

Field Summary

Fields

Modifier and Type	Field and Description
protected int	changesToApply The number of changes to apply to the database.
protected String	toTag Update to the changeSet with the given tag command.

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

changeLogDirectory, changeLogFile, contexts, labels

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

changelogCatalogName, changelogSchemaName, clearCheckSums, databaseChangeLogLockTableName, databaseChangeLogTableName, databaseClass, defaultCatalogName, defaultSchemaName, driver, emptyPassword, includeArtifact, includeTestOutputDirectory, logging, outputDefaultCatalog, outputDefaultSchema, outputFileEncoding, password, project, promptOnNonLocalDatabase, propertyFile, propertyFileWillOverride, propertyProviderClass, skip, systemProperties, url, username, verbose, wagonManager

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractLiquibaseUpdateMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	doUpdate(Liquibase liquibase) Performs the actual "update" work on the database.
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

checkRequiredParametersAreSpecified, createLiquibase, getFileOpener

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

cleanup, configureFieldsAndValues, execute, getClassLoaderIncludingProjectClasspath, getLiquibase, getMavenArtifactClassLoader, getOutputWriter, isPromptOnNonLocalDatabase, parsePropertiesFile

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

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

changesToApply

protected int changesToApply

The number of changes to apply to the database. By default this value is 0, which will result in all changes (not already applied to the database) being applied.

toTag

protected String toTag

Update to the changeSet with the given tag command.

Constructor Detail

AbstractLiquibaseUpdateMojo

public AbstractLiquibaseUpdateMojo()

Method Detail

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

doUpdate

protected abstract void doUpdate(Liquibase liquibase)
                          throws LiquibaseException

Performs the actual "update" work on the database.

Parameters:

liquibase - The Liquibase object to use to perform the "update".

Throws:

LiquibaseException

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.