Maven generateChangeLog

liquibase:generateChangeLog

Full name:

org.liquibase:liquibase-maven-plugin:3.8.8: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 changesets in the generated changelog.
liquibase.changeSetContext String 2.0.6 The execution context to be used for changesets in the generated changelog, which can be "," separated if multiple contexts.
liquibase.changelogCatalogName String 2.0.6 Specifies the schema Liquibase will use to create your changelog tables.
liquibase.changelogSchemaName String 2.0.6 Specifies the schema Liquibase will use to create your changelogtable.
liquibase.clearCheckSums boolean 2.0.6 A flag that forces 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 Specifies the table name to use for the DATABASECHANGELOGLOCK table.
liquibase.databaseChangeLogTableName String 2.0.6 Specifies the table name to use for the DATABASECHANGELOG table.
liquibase.databaseClass String 2.0.6 Specifies the database object class.
liquibase.defaultCatalogName String 2.0.6 Specifies the default catalog name to use for the database connection.
liquibase.defaultSchemaName String 2.0.6 Specifies the default schema name to use for the 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 Specifies the driver class name to use for the database connection.
driverPropertiesFile File 2.0.6 Specifies the location of a JDBC connection-properties file which contains properties the driver will use.
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 A map-based collection of changelog properties to apply.
expressionVars Properties 2.0.6 A property-based collection of changelog properties to apply.
liquibase.includeArtifact boolean 2.0.6 Includes a Maven project artifact in the class loader which obtains the liquibase.properties and changelog files.
Default value is: true.
liquibase.includeTestOutputDirectory boolean 2.0.6 Includes the Maven test output directory in the class loader which obtains the liquibase.properties and changelog files.
Default value is: true.
liquibase.liquibaseProLicenseKey String 2.0.6 Specifies your Liquibase Pro license key.
liquibase.logging String 2.0.6 Controls the amount of logging detail Liquibase outputs when executing. The values can be "DEBUG", "INFO", "WARNING", "SEVERE", or "OFF". The value is not case sensitive.
Default value is: INFO.
liquibase.outputChangeLogFile String 2.0.6 The target changelog file to output to. If this is null then the output will be to the screen.
liquibase.outputDefaultCatalog boolean 2.0.6 Specifies whether to ignore the catalog/database name.
Default value is: false.
liquibase.outputDefaultSchema boolean 2.0.6 Specifies whether to ignore the schema name.
Default value is: false.
liquibase.outputFileEncoding String 2.0.6 A flag which indicates you want to set the character encoding of the output file during the updateSQL phase.
liquibase.password String 2.0.6 Specifies the database password for database connection.
liquibase.promptOnNonLocalDatabase boolean 2.0.6 Controls whether users are prompted before executing changesets to a non-local database.
Default value is: true.
liquibase.propertyFile String 2.0.6 Specifies the liquibase.properties you want to use to configure Liquibase.
liquibase.propertyFileWillOverride boolean 2.0.6 A flag which indicates you want the liquibase.properties file to override any settings provided in the Maven plugin configuration. By default, if a property is explicitly specified it is not overridden if it also appears in the properties file.
Default value is: false.
liquibase.propertyProviderClass String 2.0.6 Specifies the property provider which must be a java.util.Properties implementation.
liquibase.server String 2.0.6 Specifies the server ID in the Maven settings.xml to use when authenticating.
liquibase.skip boolean 2.0.6 Specifies whether to skip running Liquibase. The use of this parameter is NOT RECOMMENDED but can be used when needed.
Default value is: false.
systemProperties Properties 2.0.6 Specifies a list of system properties you want to pass to the database.
liquibase.url String 2.0.6 Specifies the database URL you want to use to execute Liquibase.
liquibase.username String 2.0.6 Specifies the database username for database connection.
liquibase.verbose boolean 2.0.6 Controls the amount of output detail when you call the plugin.
Default value is: false.

Parameter Details

liquibase.changeSetAuthor:

The author to be specified for changesets in the generated changelog
  • Type: java.lang.String
  • Since: 2.0.6
  • Required: No

liquibase.changeSetContext:

The execution context to be used for changesets in the generated changelog, which can be "," separated if multiple contexts.
  • Type: java.lang.String
  • Since: 2.0.6
  • Required: No

liquibase.changelogCatalogName:

Specifies the schema Liquibase will use to create your changelog tables.
  • Type: java.lang.String
  • Since: 2.0.6
  • Required: No

liquibase.changelogSchemaName:

Specifies the schema Liquibase will use to create your changelog table.
  • Type: java.lang.String
  • Since: 2.0.6
  • Required: No

liquibase.clearCheckSums:

A flag that forces 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:

Specifies the table name to use for the DATABASECHANGELOGLOCK table.
  • Type: java.lang.String
  • Since: 2.0.6
  • Required: No

liquibase.databaseChangeLogTableName:

Specifies the table name to use for the DATABASECHANGELOG table.
  • Type: java.lang.String
  • Since: 2.0.6
  • Required: No

liquibase.databaseClass:

Specifies the database object class.
  • Type: java.lang.String
  • Since: 2.0.6
  • Required: No

liquibase.defaultCatalogName:

Specifies the default catalog name to use for the database connection.
  • Type: java.lang.String
  • Since: 2.0.6
  • Required: No

liquibase.defaultSchemaName:

Specifies the default schema name to use for the 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 changelog 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:

Specifies the driver class name to use for the database connection.
  • Type: java.lang.String
  • Since: 2.0.6
  • Required: No

driverPropertiesFile:

Specifies the location of a JDBC connection-properties file which contains properties the driver will use.
  • 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:

A map-based collection of changelog properties to apply.
  • Type: java.util.Map
  • Since: 2.0.6
  • Required: No

expressionVars:

A property-based collection of changelog properties to apply.
  • Type: java.util.Properties
  • Since: 2.0.6
  • Required: No

liquibase.includeArtifact:

Includes a Maven project artifact in the class loader which obtains theliquibase.properties and changelog files.
  • Type: boolean
  • Since: 2.0.6
  • Required: No
  • Default: true

liquibase.includeTestOutputDirectory:

Includes the Maven test output directory in the class loader which obtains the liquibase.properties and changelog files.
  • Type: boolean
  • Since: 2.0.6
  • Required: No
  • Default: true

liquibase.liquibaseProLicenseKey:

Specifies your Liquibase Pro license key.
  • Type: java.lang.String
  • Since: 2.0.6
  • Required: No

liquibase.logging:

Controls the amount of logging detail Liquibase outputs when executing. The values can be "DEBUG", "INFO", "WARNING", "SEVERE", or "OFF". The value is not case sensitive.
  • Type: java.lang.String
  • Since: 2.0.6
  • Required: No
  • Default: INFO

liquibase.outputChangeLogFile:

The target changelog 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:

Specifies whether to ignore the catalog/database name.
  • Type: boolean
  • Since: 2.0.6
  • Required: No
  • Default: false

liquibase.outputDefaultSchema:

Specifies whether to ignore the schema name.
  • Type: boolean
  • Since: 2.0.6
  • Required: No
  • Default: false

liquibase.outputFileEncoding:

A flag which indicates you want to set the character encoding of the output file during the updateSQL phase.
  • Type: java.lang.String
  • Since: 2.0.6
  • Required: No

liquibase.password:

Specifies the database password for database connection.
  • Type: java.lang.String
  • Since: 2.0.6
  • Required: No

liquibase.promptOnNonLocalDatabase:

Controls whether users are prompted before executing changesets to a non-local database.
  • Type: boolean
  • Since: 2.0.6
  • Required: No
  • Default: true

liquibase.propertyFile:

Specifies the liquibase.properties you want to use to configure Liquibase.
  • Type: java.lang.String
  • Since: 2.0.6
  • Required: No

liquibase.propertyFileWillOverride:

A flag which indicates you want the liquibase.properties file to override any settings provided in the Maven plugin configuration. By default, if a property is explicitly 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:

Specifies the property provider which must be a java.util.Properties implementation.
  • Type: java.lang.String
  • Since: 2.0.6
  • Required: No

liquibase.server:

Specifies the server ID in the Maven settings.xml to use when authenticating.
  • Type: java.lang.String
  • Since: 2.0.6
  • Required: No

liquibase.skip:

Specifies whether to skip running Liquibase. The use of this parameter is NOT RECOMMENDED but can be used when needed.
  • Type: boolean
  • Since: 2.0.6
  • Required: No
  • Default: false

systemProperties:

Specifies a list of system properties you want to pass to the database.
  • Type: java.util.Properties
  • Since: 2.0.6
  • Required: No

liquibase.url:

Specifies the database URL you want to use to execute Liquibase.
  • Type: java.lang.String
  • Since: 2.0.6
  • Required: No

liquibase.username:

Specifies the database username for database connection.
  • Type: java.lang.String
  • Since: 2.0.6
  • Required: No

liquibase.verbose:

Controls the amount of output detail when you call the plugin.
  • Type: boolean
  • Since: 2.0.6
  • Required: No
  • Default: false