Maven changelogSyncSQL

changelogSyncSQL is a helper goal that produces the raw SQL Liquibase would run when using the changelogSync goal.

Uses

changelogSyncSQL is typically used when you want to inspect the SQL Liquibase will use to baseline a new database environment and update the DATABASECHANGELOG table to mark all changes that are not applied to the database as executed.

It is best practice to inspect any SQL that Liquibase would run when using the changelogSync goal so you can review any changes the goal would make to your database before running the goal.

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 your pom.xml does not reference a liquibase.properties file, include <changeLogFile> specify your changelog file here</changeLogFile> to the pom.xml.

Running the changelogSyncSQL Maven goal

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

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

mvn liquibase:changelogSyncSQL

Note: You can also add the liquibase.migrationSqlOutputFile attribute and specify the file to output the migration SQL script to. The default file is migrate.sql. If it exists, it will be overwritten.

changelogSyncSQL optional Maven configuration attributes

Attribute Definition
liquibase.changeLogDirectory Specifies the directory where Liquibase can find your changelog file.
liquibase.changeLogFile Specifies the changelog file for Liquibase to use.
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.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.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 [boolean] Deprecated. 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.labels Specifies which labels Liquibase will execute, which can be separated by a comma if multiple labels are required or you need to designate a more complex expression. If a label is not specified, then all labels will be executed.
liquibase.liquibaseProLicenseKey Specifies your Liquibase Pro license key.
liquibase.migrationSqlOutputFile Specifies the file to output the migration SQL script to. If it exists, it will be overwritten.
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 [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 you want to use to configure Liquibase.
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.