Package org.liquibase.maven.plugins

Class LiquibaseChangeLogSyncToTagSQLMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.liquibase.maven.plugins.AbstractLiquibaseMojo

org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

org.liquibase.maven.plugins.LiquibaseChangeLogSyncToTagSQLMojo

All Implemented Interfaces:

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

public class LiquibaseChangeLogSyncToTagSQLMojo
extends AbstractLiquibaseChangeLogMojo

Generates SQL that marks all unapplied changes up to and including a specified tag as applied.

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

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
LiquibaseChangeLogSyncToTagSQLMojo()

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	cleanup(Database db)
protected Liquibase	createLiquibase(Database db)
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

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.

toTag

@PropertyElement
protected String toTag

Update to the changeSet with the given tag command.

Constructor Details

LiquibaseChangeLogSyncToTagSQLMojo

public LiquibaseChangeLogSyncToTagSQLMojo()

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.

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

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.

createLiquibase

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

Overrides:

createLiquibase in class AbstractLiquibaseChangeLogMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

cleanup

protected void cleanup(Database db)

Overrides:

cleanup in class AbstractLiquibaseMojo