org.liquibase.maven.plugins

Class LiquibaseChecksRunMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.liquibase.maven.plugins.AbstractLiquibaseMojo

org.liquibase.maven.plugins.AbstractLiquibaseChecksMojo

org.liquibase.maven.plugins.LiquibaseChecksRunMojo

All Implemented Interfaces:

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

public class LiquibaseChecksRunMojo
extends AbstractLiquibaseChecksMojo

Check the changelog for issues

Field Summary

Fields

Modifier and Type	Field and Description
protected String	autoUpdate Allows automatic backup and updating of liquibase.checks.conf file when new quality checks are available.
protected String	changeLogFile Specifies the changelog file for Liquibase Quality Checks to use.
protected String	checkName Comma-separated list of one or more enabled checks to run.
protected String	checksScope The Liquibase component to run checks against, which can be a comma separated list
protected String	defaultCatalogName The default catalog name to use for the database connection
protected String	defaultSchemaName The default schema name to use for the database connection
protected String	driver The JDBC driver class
protected String	driverPropertiesFile The JDBC driver properties file
protected String	format Specifies the format file for Liquibase Quality Checks to use.
protected File	outputFile
protected String	password Password to use to connect to the database
protected String	schemas The schemas to snapshot
protected String	url The JDBC database connection URL.
protected String	username Username to use to connect to the database

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

checksSettingsFile

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

changeExecListenerClass, changeExecListenerPropertiesFile, changelogCatalogName, changelogSchemaName, clearCheckSums, commandName, databaseChangeLogLockTableName, databaseChangeLogTableName, databaseClass, defaultChangeExecListener, emptyPassword, includeArtifact, includeTestOutputDirectory, logging, outputDefaultCatalog, outputDefaultSchema, outputFileEncoding, 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, verbose, wagonManager

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

ROLE

Constructor Summary

Constructors

Constructor and Description
LiquibaseChecksRunMojo()

Method Summary

Modifier and Type	Method and Description
protected void	performLiquibaseTask(Liquibase liquibase)

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

databaseConnectionRequired

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

checkRequiredParametersAreSpecified, cleanup, configureChangeLogProperties, configureFieldsAndValues, createLiquibase, execute, getClassLoaderIncludingProjectClasspath, getField, getLicenseKey, getLiquibase, getMavenArtifactClassLoader, getOutputWriter, getResourceAccessor, isPromptOnNonLocalDatabase, parsePropertiesFile, printSettings, 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

changeLogFile

@PropertyElement
protected String changeLogFile

Specifies the changelog file for Liquibase Quality Checks to use.

format

@PropertyElement
protected String format

Specifies the format file for Liquibase Quality Checks to use. If not specified, the default format will be used.

checksScope

@PropertyElement
protected String checksScope

The Liquibase component to run checks against, which can be a comma separated list

autoUpdate

@PropertyElement
protected String autoUpdate

Allows automatic backup and updating of liquibase.checks.conf file when new quality checks are available. Options: [on|off]

checkName

@PropertyElement
protected String checkName

Comma-separated list of one or more enabled checks to run. If not specified, all enabled checks will run. Example: --check-name=shortname1,shortname2,shortname3

username

@PropertyElement
protected String username

Username to use to connect to the database

password

@PropertyElement
protected String password

Password to use to connect to the database

url

@PropertyElement
protected String url

The JDBC database connection URL. One of --changelog-file or --url is required.

schemas

@PropertyElement
protected String schemas

The schemas to snapshot

defaultSchemaName

@PropertyElement
protected String defaultSchemaName

The default schema name to use for the database connection

defaultCatalogName

@PropertyElement
protected String defaultCatalogName

The default catalog name to use for the database connection

driver

@PropertyElement
protected String driver

The JDBC driver class

driverPropertiesFile

@PropertyElement
protected String driverPropertiesFile

The JDBC driver properties file

outputFile

@PropertyElement
protected File outputFile

Constructor Detail

LiquibaseChecksRunMojo

public LiquibaseChecksRunMojo()

Method Detail

performLiquibaseTask

protected void performLiquibaseTask(Liquibase liquibase)
                             throws CommandExecutionException

Specified by:

performLiquibaseTask in class AbstractLiquibaseMojo

Throws:

CommandExecutionException