Package org.liquibase.maven.plugins

Class LiquibaseUpdateSQL

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.liquibase.maven.plugins.AbstractLiquibaseMojo

org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

org.liquibase.maven.plugins.AbstractLiquibaseUpdateMojo

org.liquibase.maven.plugins.LiquibaseUpdateSQL

All Implemented Interfaces:

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

public class LiquibaseUpdateSQL
extends AbstractLiquibaseUpdateMojo

Generates the SQL that is required to update the database to the current version as specified in the DatabaseChangeLogs.

Field Summary

Fields

Modifier and Type	Field	Description
protected File	migrationSqlOutputFile	The file to output the Migration SQL script to, if it exists it will be overwritten.

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

changesToApply, rollbackOnError, showSummary, showSummaryOutput, toTag

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

changeLogDirectory, changeLogFile, contexts, duplicateFileMode, labelFilter, labels

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

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, systemProperties, url, username, verbose, wagonManager

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

ROLE

Constructor Summary

Constructors

Constructor	Description
LiquibaseUpdateSQL()

Method Summary

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

handleUpdateException, performLiquibaseTask

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

checkRequiredParametersAreSpecified, getLabelFilter, getResourceAccessor

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

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

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

migrationSqlOutputFile

@PropertyElement
protected File migrationSqlOutputFile

The file to output the Migration SQL script to, if it exists it will be overwritten.

Constructor Details

LiquibaseUpdateSQL

public LiquibaseUpdateSQL()

Method Details

doUpdate

protected void doUpdate(Liquibase liquibase)
                 throws LiquibaseException

Description copied from class: AbstractLiquibaseUpdateMojo

Performs the actual "update" work on the database.

Specified by:

doUpdate in class AbstractLiquibaseUpdateMojo

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 AbstractLiquibaseUpdateMojo

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 AbstractLiquibaseUpdateMojo

Parameters:

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

cleanup

protected void cleanup(Database db)

Overrides:

cleanup in class AbstractLiquibaseMojo