Maven generateChangeLog

generateChangeLog creates a changelog file that has a sequence of changesets which describe how to re-create the current state of the database.

Uses

generateChangeLog is typically used when you want to capture the current state of a database, then apply those changes to any number of databases. This is typically only done when a project has an existing database but hasn't used Liquibase before. See How to set up Liquibase with an Existing Project and Multiple Environments for more details.

Note: When using the update goal to apply the changes in the changelog, Liquibase will not create a new database or schema. You must create them before applying the changelog to it.

Maven configuration

Liquibase Maven can be configured in multiple ways. One way is to define your Liquibase configuration properties in your pom.xml file. To configure your pom.xml file, refer to Configuring Liquibase Attributes in your Maven POM File. If pom.xml does not reference a Liquibase properties file, include specify your changelog file here to the pom.xml.

Before running the generateChangeLog goal, add <outputChangeLogFile>specify the changelog file name you want to generate here</outputChangeLogFile> to your pom.xml file.

Running the generateChangeLog Maven goal

Running the generateChangeLog goal requires a Maven project to be implemented.

To run the goal, type the following in your command prompt:

mvn liquibase:generateChangeLog

generateChangeLog optional Maven configuration attributes

Attribute Definition
liquibase.changeSetAuthor Specifies the author for changesets in the generated changelog.
liquibase.changeSetContext Specifies the execution context to be used for changesets in the generated changelog, which can be "," separated if there are multiple contexts.
liquibase.changelogCatalogName

Specifies the catalog Liquibase will use to create your changelog tables.

liquibase.changelogSchemaName

Specifies the schema Liquibase will use to create your changelog tables.

liquibase.clearCheckSums

Boolean. Forces checksums to be cleared from the DATABASECHANGELOG table. Default value is: false.

liquibase.contexts

Specifies which contexts Liquibase will execute, which can be separated by a comma if multiple contexts are required. If a context is not specified, then all contexts will be executed.

liquibase.dataDir

Specifies the directory where insert statement CSV files will be kept.

liquibase.databaseChangeLogLockTableName

Specifies the table name to use for the DATABASECHANGELOGLOCK table.

liquibase.databaseChangeLogTableName

Specifies the table name to use for the DATABASECHANGELOG table.

liquibase.databaseClass

Specifies the database object class.

liquibase.defaultCatalogName

Specifies the default catalog name to use for the database connection.

liquibase.defaultSchemaName

Specifies the default schema name to use for the database connection.

liquibase.diffExcludeObjects

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

liquibase.diffIncludeObjects

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

liquibase.diffTypes

Specifies the list of diff types to include in the 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
liquibase.driver

Specifies the driver class name to use for the database connection.

driverPropertiesFile

Specifies the location of a JDBC connection properties file which contains properties the driver will use.

liquibase.emptyPassword

Deprecated. Boolean. Use an empty or null value for the password instead. Default value is: false.

expressionVariables

Specifies a map-based collection of changelog properties to apply.

expressionVars

Specifies a property-based collection of changelog properties to apply.

liquibase.includeArtifact

Boolean. Includes a Maven project artifact in the class loader, which obtains the Liquibase properties file and changelog files. Default value is true.

liquibase.includeTestOutputDirectory

Boolean. Includes the Maven test output directory in the class loader which obtains the Liquibase properties file and changelog files. Default value is true.

liquibase.liquibaseProLicenseKey

Specifies your Liquibase Pro license key.

liquibase.outputChangeLogFile

Specifies the target changelog file to output to. If this is null then the output will be to the screen.

liquibase.outputDefaultCatalog

Boolean. Specifies whether to ignore the catalog or database name. Default value is: false.

liquibase.outputDefaultSchema

Boolean. Specifies whether to ignore the schema name. Default value is: false.

liquibase.outputFileEncoding

Indicates that you want to set the character encoding of the output file during the updateSQL phase.

liquibase.password

Specifies the database password for the database connection.

liquibase.promptOnNonLocalDatabase

Deprecated. Boolean. Controls whether users are prompted before executing changesets to a non-local database. Default value is: true.

liquibase.propertyFile

Specifies the Liquibase properties file to use for configuration, like liquibase.properties.

liquibase.propertyFileWillOverride

Boolean. Indicates that 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

Specifies the property provider, which must be a java.util.Properties implementation.

liquibase.server

Specifies the server ID in the Maven settings.xml to use when authenticating.

liquibase.skip

Boolean. Specifies whether to skip running Liquibase. The use of this attribute is not recommended but can be used when needed. Default value is: false.

systemProperties

Specifies a list of system properties you want to pass to the database.

liquibase.url

Specifies the database URL you want to use to execute Liquibase.

liquibase.username

Specifies the database username for the database connection.

liquibase.verbose

Boolean. Controls the amount of output detail when you call the plugin. Default value is: false.