Maven generateChangeLog

liquibase:generateChangeLog

Full name:

org.liquibase:liquibase-maven-plugin:3.8.3:generateChangeLog

Description:

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

Attributes:

Requires a Maven 2.0 project to be executed.
Requires dependency resolution of artifacts in scope: test.
Since version: 2.0.6.

Optional Parameters

Name	Type	Since	Description
liquibase.changeSetAuthor	String	2.0.6	The author to be specified for Change Sets in the generated Change Log.
liquibase.changeSetContext	String	2.0.6	The execution context to be used for Change Sets in the generated Change Log, which can be "," separated if multiple contexts.
liquibase.changelogCatalogName	String	2.0.6	Schema against which Liquibase changelog tables will be created.
liquibase.changelogSchemaName	String	2.0.6	Schema against which Liquibase changelog tables will be created.
liquibase.clearCheckSums	boolean	2.0.6	Flag for forcing the checksums to be cleared from the DatabaseChangeLog table. Default value is: false.
liquibase.contexts	String	2.0.6	are required. If no context is specified then ALL contexts will be executed.
liquibase.dataDir	String	2.0.6	Directory where insert statement csv files will be kept.
liquibase.databaseChangeLogLockTableName	String	2.0.6	Table name to use for the databasechangelog.
liquibase.databaseChangeLogTableName	String	2.0.6	Table name to use for the databasechangelog.
liquibase.databaseClass	String	2.0.6	The class to use as the database object.
liquibase.defaultCatalogName	String	2.0.6	The default catalog name to use the for database connection.
liquibase.defaultSchemaName	String	2.0.6	The default schema name to use the for database connection.
liquibase.diffExcludeObjects	String	2.0.6	Objects to be excluded from the changelog. Example filters: "table_name", "table:main_.", "column:._lock, table:primary.*".
liquibase.diffIncludeObjects	String	2.0.6	Objects to be included in the changelog. Example filters: "table_name", "table:main_.", "column:._lock, table:primary.*".
liquibase.diffTypes	String	2.0.6	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
liquibase.driver	String	2.0.6	The fully qualified name of the driver class to use to connect to the database.
driverPropertiesFile	File	2.0.6	Location of a properties file containing JDBC connection properties for use by the driver.
liquibase.emptyPassword	boolean	2.0.6	Deprecated. Use an empty or null value for the password instead. Default value is: false.
expressionVariables	Map	2.0.6	Array to put a expression variable to maven plugin.
expressionVars	Properties	2.0.6	Array to put a expression variable to maven plugin.
liquibase.includeArtifact	boolean	2.0.6	Allows for the maven project artifact to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files. Default value is: true.
liquibase.includeTestOutputDirectory	boolean	2.0.6	Allows for the maven test output directory to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files. Default value is: true.
liquibase.liquibaseProLicenseKey	String	2.0.6	Liquibase PRO license key value
liquibase.logging	String	2.0.6	Controls the level of logging from Liquibase when executing. The value can be "debug", "info", "warning", "severe", or "off". The value is case insensitive. Default value is: INFO.
liquibase.outputChangeLogFile	String	2.0.6	The target change log file to output to. If this is null then the output will be to the screen.
liquibase.outputDefaultCatalog	boolean	2.0.6	Whether to ignore the catalog/database name.
liquibase.outputDefaultSchema	boolean	2.0.6	Whether to ignore the schema name.
liquibase.outputFileEncoding	String	2.0.6	Flag to set the character encoding of the output file produced by Liquibase during the updateSQL phase.
liquibase.password	String	2.0.6	The database password to use to connect to the specified database.
liquibase.promptOnNonLocalDatabase	boolean	2.0.6	Controls the prompting of users as to whether or not they really want to run the changes on a database that is not local to the machine that the user is current executing the plugin on. Default value is: true.
liquibase.propertyFile	String	2.0.6	The Liquibase properties file used to configure the Liquibase Liquibase.
liquibase.propertyFileWillOverride	boolean	2.0.6	Flag allowing for the Liquibase properties file to override any settings provided in the Maven plugin configuration. By default if a property is explicity specified it is not overridden if it also appears in the properties file. Default value is: false.
liquibase.propertyProviderClass	String	2.0.6	The class to use as the property provider (must be a java.util.Properties implementation).
liquibase.server	String	2.0.6	The server id in settings.xml to use when authenticating with.
liquibase.skip	boolean	2.0.6	Set this to 'true' to skip running liquibase. Its use is NOT RECOMMENDED, but quite convenient on occasion. Default value is: false.
systemProperties	Properties	2.0.6	List of system properties to pass to the database.
liquibase.url	String	2.0.6	The Database URL to connect to for executing Liquibase.
liquibase.username	String	2.0.6	The database username to use to connect to the specified database.
liquibase.verbose	boolean	2.0.6	Controls the verbosity of the output from invoking the plugin. Default value is: false.

Parameter Details

liquibase.changeSetAuthor:

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

Type: java.lang.String
Since: 2.0.6
Required: No

liquibase.changeSetContext:

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

Type: java.lang.String
Since: 2.0.6
Required: No

liquibase.changelogCatalogName:

Schema against which Liquibase changelog tables will be created.

Type: java.lang.String
Since: 2.0.6
Required: No

liquibase.changelogSchemaName:

Schema against which Liquibase changelog tables will be created.

Type: java.lang.String
Since: 2.0.6
Required: No

liquibase.clearCheckSums:

Flag for forcing the checksums to be cleared from the DatabaseChangeLog table.

Type: boolean
Since: 2.0.6
Required: No
Default: false

liquibase.contexts:

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

Type: java.lang.String
Since: 2.0.6
Required: No

liquibase.dataDir:

Directory where insert statement csv files will be kept.

Type: java.lang.String
Since: 2.0.6
Required: No

liquibase.databaseChangeLogLockTableName:

Table name to use for the databasechangelog.

Type: java.lang.String
Since: 2.0.6
Required: No

liquibase.databaseChangeLogTableName:

Table name to use for the databasechangelog.

Type: java.lang.String
Since: 2.0.6
Required: No

liquibase.databaseClass:

The class to use as the database object.

Type: java.lang.String
Since: 2.0.6
Required: No

liquibase.defaultCatalogName:

The default catalog name to use the for database connection.

Type: java.lang.String
Since: 2.0.6
Required: No

liquibase.defaultSchemaName:

The default schema name to use the for database connection.

Type: java.lang.String
Since: 2.0.6
Required: No

liquibase.diffExcludeObjects:

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

Type: java.lang.String
Since: 2.0.6
Required: No

liquibase.diffIncludeObjects:

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

Type: java.lang.String
Since: 2.0.6
Required: No

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

Type: java.lang.String
Since: 2.0.6
Required: No

liquibase.driver:

The fully qualified name of the driver class to use to connect to the database.

Type: java.lang.String
Since: 2.0.6
Required: No

driverPropertiesFile:

Location of a properties file containing JDBC connection properties for use by the driver.

Type: java.io.File
Since: 2.0.6
Required: No

liquibase.emptyPassword:

Deprecated. Use an empty or null value for the password instead.

Use an empty string as the password for the database connection. This should not be used along side the password setting.

Type: boolean
Since: 2.0.6
Required: No
Default: false

expressionVariables:

Array to put a expression variable to maven plugin.

Type: java.util.Map
Since: 2.0.6
Required: No

expressionVars:

Array to put a expression variable to maven plugin.

Type: java.util.Properties
Since: 2.0.6
Required: No

liquibase.includeArtifact:

Allows for the maven project artifact to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files.

Type: boolean
Since: 2.0.6
Required: No
Default: true

liquibase.includeTestOutputDirectory:

Allows for the maven test output directory to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files.

Type: boolean
Since: 2.0.6
Required: No
Default: true

liquibase.liquibaseProLicenseKey:

Liquibase PRO license key value

Type: java.lang.String
Since: 2.0.6
Required: No

liquibase.logging:

Controls the level of logging from Liquibase when executing. The value can be "debug", "info", "warning", "severe", or "off". The value is case insensitive.

Type: java.lang.String
Since: 2.0.6
Required: No
Default: INFO

liquibase.outputChangeLogFile:

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

Type: java.lang.String
Since: 2.0.6
Required: No

liquibase.outputDefaultCatalog:

Whether to ignore the catalog/database name.

Type: boolean
Since: 2.0.6
Required: No

liquibase.outputDefaultSchema:

Whether to ignore the schema name.

Type: boolean
Since: 2.0.6
Required: No

liquibase.outputFileEncoding:

Flag to set the character encoding of the output file produced by Liquibase during the updateSQL phase.

Type: java.lang.String
Since: 2.0.6
Required: No

liquibase.password:

The database password to use to connect to the specified database.

Type: java.lang.String
Since: 2.0.6
Required: No

liquibase.promptOnNonLocalDatabase:

Controls the prompting of users as to whether or not they really want to run the changes on a database that is not local to the machine that the user is current executing the plugin on.

Type: boolean
Since: 2.0.6
Required: No
Default: true

liquibase.propertyFile:

The Liquibase properties file used to configure the Liquibase Liquibase.

Type: java.lang.String
Since: 2.0.6
Required: No

liquibase.propertyFileWillOverride:

Flag allowing for the Liquibase properties file to override any settings provided in the Maven plugin configuration. By default if a property is explicity specified it is not overridden if it also appears in the properties file.

Type: boolean
Since: 2.0.6
Required: No
Default: false

liquibase.propertyProviderClass:

The class to use as the property provider (must be a java.util.Properties implementation).