Package 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:

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.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	changesToApply	The number of changes to apply to the database.
protected boolean	rollbackOnError	If set to true and any changeset in a deployment fails, then the update operation stops, and liquibase attempts to rollback all changesets just deployed.
protected UpdateSummaryEnum	showSummary	Whether or not to print a summary of the update operation.
protected UpdateSummaryOutputEnum	showSummaryOutput	Flag to control where we show the summary.
protected String	toTag	Update to the changeSet with the given tag command.

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, licenseUtilityEnabled, licenseUtilityTrackingId, licenseUtilityUrl, 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
AbstractLiquibaseUpdateMojo()

Method Summary

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

changesToApply

@PropertyElement
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.

rollbackOnError

@PropertyElement
protected boolean rollbackOnError

If set to true and any changeset in a deployment fails, then the update operation stops, and liquibase attempts to rollback all changesets just deployed. A changeset marked "failOnError=false" does not trigger as an error, therefore rollback-on-error will not occur. Additionally, if a changeset is not auto-rollback compliant or does not have a rollback script, then no rollback-on-error will occur for any changeset.

showSummary

@PropertyElement
protected UpdateSummaryEnum showSummary

Whether or not to print a summary of the update operation. Allowed values: 'OFF', 'SUMMARY' (default), 'VERBOSE'

showSummaryOutput

@PropertyElement
protected UpdateSummaryOutputEnum showSummaryOutput

Flag to control where we show the summary. Allowed values: 'LOG', 'CONSOLE', OR 'ALL' (default)

Constructor Details

AbstractLiquibaseUpdateMojo

public AbstractLiquibaseUpdateMojo()

Method Details

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

createLiquibase

protected Liquibase createLiquibase(Database db)
                             throws org.apache.maven.plugin.MojoExecutionException

Overrides:

createLiquibase in class AbstractLiquibaseChangeLogMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

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.

handleUpdateException

protected void handleUpdateException(LiquibaseException exception)
                              throws LiquibaseException

Throws:

LiquibaseException