org.liquibase.maven.plugins

Class LiquibaseDatabaseDiff

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.liquibase.maven.plugins.AbstractLiquibaseMojo

org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

org.liquibase.maven.plugins.LiquibaseDatabaseDiff

All Implemented Interfaces:

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

public class LiquibaseDatabaseDiff
extends AbstractLiquibaseChangeLogMojo

Generates a diff between the specified database and the reference database. The output is either a report or a changelog depending on the value of the diffChangeLogFile parameter.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	diffChangeLogFile If this parameter is set, the changelog needed to "fix" differences between the two databases is output.
protected String	diffExcludeObjects Objects to be excluded from the changelog.
protected boolean	diffIncludeCatalog Include the catalog in the diff output? If this is null then the catalog will not be included
protected String	diffIncludeObjects Objects to be included in the changelog.
protected boolean	diffIncludeSchema Include the schema in the diff output? If this is null then the schema will not be included
protected boolean	diffIncludeTablespace Include the tablespace in the diff output? If this is null then the tablespace will not be included
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 String	format The format in which to display the diff output TXT or JSON
protected String	outputFile Write the output of the diff to a file
protected String	outputSchemas Output schemas names.
protected String	referenceDefaultCatalogName The reference database catalog.
protected String	referenceDefaultSchemaName The reference database schema.
protected String	referenceDriver The fully qualified name of the driver class to use to connect to the reference database.
protected String	referencePassword The reference database password to use to connect to the specified database.
protected String	referenceSchemas Schemas names on reference database to use in diff.
protected String	referenceServer The server id in settings.xml to use when authenticating with.
protected String	referenceUrl The reference database URL to connect to for executing Liquibase.
protected String	referenceUsername The reference database username to use to connect to the specified database.
protected String	schemas Schemas on target database to use in diff.

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

changeLogDirectory, changeLogFile, contexts, duplicateFileMode, hubApiKey, hubMode, hubUrl, labelFilter, labels

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

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.
void	execute()
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

createLiquibase, getLabelFilter, getResourceAccessor

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

cleanup, configureChangeLogProperties, configureFieldsAndValues, databaseConnectionRequired, getClassLoaderIncludingProjectClasspath, getField, getLicenseKey, getLiquibase, getMavenArtifactClassLoader, getOutputWriter, 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

referenceDriver

@PropertyElement
protected String referenceDriver

The fully qualified name of the driver class to use to connect to the reference database. If this is not specified, then the AbstractLiquibaseMojo.driver will be used instead.

referenceUrl

@PropertyElement
protected String referenceUrl

The reference database URL to connect to for executing Liquibase.

referenceUsername

@PropertyElement
protected String referenceUsername

The reference database username to use to connect to the specified database.

referencePassword

@PropertyElement
protected String referencePassword

The reference database password to use to connect to the specified database. If this is null then an empty password will be used.

referenceDefaultCatalogName

@PropertyElement
protected String referenceDefaultCatalogName

The reference database catalog.

referenceDefaultSchemaName

@PropertyElement
protected String referenceDefaultSchemaName

The reference database schema.

diffChangeLogFile

@PropertyElement
protected String diffChangeLogFile

If this parameter is set, the changelog needed to "fix" differences between the two databases is output. If the file exists, it is appended to. If this is null, a comparison report is output to stdout.

diffIncludeCatalog

@PropertyElement
protected boolean diffIncludeCatalog

Include the catalog in the diff output? If this is null then the catalog will not be included

diffIncludeSchema

@PropertyElement
protected boolean diffIncludeSchema

Include the schema in the diff output? If this is null then the schema will not be included

diffIncludeTablespace

@PropertyElement
protected boolean diffIncludeTablespace

Include the tablespace in the diff output? If this is null then the tablespace will not be included

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

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

referenceServer

@PropertyElement
protected String referenceServer

The server id in settings.xml to use when authenticating with.

schemas

@PropertyElement
protected String schemas

Schemas on target database to use in diff. This is a CSV list.

referenceSchemas

@PropertyElement
protected String referenceSchemas

Schemas names on reference database to use in diff. This is a CSV list.

outputSchemas

@PropertyElement
protected String outputSchemas

Output schemas names. This is a CSV list.

outputFile

@PropertyElement
protected String outputFile

Write the output of the diff to a file

format

@PropertyElement
protected String format

The format in which to display the diff output TXT or JSON

Constructor Detail

LiquibaseDatabaseDiff

public LiquibaseDatabaseDiff()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractLiquibaseMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

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.

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.