org.liquibase.maven.plugins

Class LiquibaseGenerateChangeLogMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.liquibase.maven.plugins.AbstractLiquibaseMojo

org.liquibase.maven.plugins.LiquibaseGenerateChangeLogMojo

All Implemented Interfaces:

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

public class LiquibaseGenerateChangeLogMojo
extends AbstractLiquibaseMojo

Generates a changelog based on the current database schema. Typically used when beginning to use Liquibase on an existing project and database schema.

Since:

2.0.6

Field Summary

Fields

Modifier and Type	Field and Description
protected String	changeSetAuthor The author to be specified for Changesets in the generated Change Log.
protected String	changeSetContext The execution context to be used for Changesets in the generated Change Log, which can be "," separated if multiple contexts.
protected String	contexts are required.
protected String	dataDir Directory where insert statement csv files will be kept.
protected String	diffExcludeObjects Objects to be excluded from the changelog.
protected String	diffIncludeObjects Objects to be included in the changelog.
protected String	diffTypes List of diff types to include in Change Log expressed as a comma separated list from: tables, views, columns, indexes, foreignkeys, primarykeys, uniqueconstraints, data.
protected Boolean	includeSchema Flag to Indicate liquibase whether or not to include schema name on changelog
protected String	outputChangeLogFile The target change log file to output to.
protected boolean	overwriteOutputFile Flag to allow overwriting of output changelog file
protected String	schemas Specifies the a list of schemas to indicate liquibase where to apply change objects or where to read current state from

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

changeExecListenerClass, changeExecListenerPropertiesFile, changelogCatalogName, changelogSchemaName, clearCheckSums, commandName, databaseChangeLogLockTableName, databaseChangeLogTableName, databaseClass, defaultCatalogName, defaultChangeExecListener, defaultSchemaName, driver, emptyPassword, includeArtifact, includeTestOutputDirectory, logging, outputDefaultCatalog, outputDefaultSchema, outputFileEncoding, password, preserveSchemaCase, project, promptOnNonLocalDatabase, propertyFile, propertyFileWillOverride, propertyProviderClass, psqlArgs, psqlExecutorName, psqlKeepTemp, psqlKeepTempName, psqlKeepTempPath, psqlLogFile, psqlPath, psqlTimeout, searchPath, showBanner, skip, sqlcmdArgs, sqlcmdCatalogName, sqlcmdExecutorName, sqlcmdKeepTemp, sqlcmdKeepTempName, sqlcmdKeepTempOverwrite, sqlcmdKeepTempPath, sqlcmdLogFile, sqlcmdPath, sqlcmdTimeout, sqlPlusArgs, sqlPlusExecutorName, 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 and Description
LiquibaseGenerateChangeLogMojo()

Method Summary

Modifier and Type	Method and Description
protected void	checkRequiredParametersAreSpecified() Performs some validation after the properties file has been loaded checking that all properties required have been specified.
protected void	performLiquibaseTask(Liquibase 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.AbstractLiquibaseMojo

cleanup, configureChangeLogProperties, configureFieldsAndValues, createLiquibase, databaseConnectionRequired, execute, getClassLoaderIncludingProjectClasspath, getField, getLicenseKey, getLiquibase, getMavenArtifactClassLoader, getOutputWriter, getResourceAccessor, isPromptOnNonLocalDatabase, parsePropertiesFile, setupBindInfoPackage

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

diffTypes

@PropertyElement
protected String diffTypes

List of diff types to include in Change Log expressed as a comma separated list from: tables, views, columns, indexes, foreignkeys, primarykeys, uniqueconstraints, data. If this is null then the default types will be: tables, views, columns, indexes, foreignkeys, primarykeys, uniqueconstraints

dataDir

@PropertyElement
protected String dataDir

Directory where insert statement csv files will be kept.

changeSetAuthor

@PropertyElement
protected String changeSetAuthor

The author to be specified for Changesets in the generated Change Log.

contexts

@PropertyElement
protected String contexts

are required. If no context is specified then ALL contexts will be executed.

changeSetContext

@PropertyElement
protected String changeSetContext

The execution context to be used for Changesets in the generated Change Log, which can be "," separated if multiple contexts.

outputChangeLogFile

@PropertyElement
protected String outputChangeLogFile

The target change log file to output to. If this is null then the output will be to the screen.

diffExcludeObjects

@PropertyElement
protected String diffExcludeObjects

Objects to be excluded from the changelog. Example filters: "table_name", "table:main_.*", "column:*._lock, table:primary.*".

diffIncludeObjects

@PropertyElement
protected String diffIncludeObjects

Objects to be included in the changelog. Example filters: "table_name", "table:main_.*", "column:*._lock, table:primary.*".

schemas

@PropertyElement
protected String schemas

Specifies the a list of schemas to indicate liquibase where to apply change objects or where to read current state from

includeSchema

@PropertyElement
protected Boolean includeSchema

Flag to Indicate liquibase whether or not to include schema name on changelog

overwriteOutputFile

@PropertyElement
protected boolean overwriteOutputFile

Flag to allow overwriting of output changelog file

Constructor Detail

LiquibaseGenerateChangeLogMojo

public LiquibaseGenerateChangeLogMojo()

Method Detail

performLiquibaseTask

protected void performLiquibaseTask(Liquibase liquibase)
                             throws LiquibaseException

Specified by:

performLiquibaseTask in class AbstractLiquibaseMojo

Throws:

LiquibaseException

checkRequiredParametersAreSpecified

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

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

Overrides:

checkRequiredParametersAreSpecified in class AbstractLiquibaseMojo

Throws:

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

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 AbstractLiquibaseMojo

Parameters:

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