Maven `changelogSyncToTagSQL`

changelogSyncToTagSQL is a helper goal that produces the raw SQL that Liquibase would run when using the changelogSyncToTag goal to mark all undeployed changesets associated with the specified tag as executed in your database.

Uses

The changelogSyncToTagSQL goal is typically used when you want to inspect the SQL Liquibase will use to baseline a new database environment.

It is best practice to inspect any SQL that Liquibase would run when using the changelogSyncToTag goal so you can review any changes the goal would make to your database before running it. The changelogSyncToTag goal marks all changesets starting with the first changeset at the top of the changelog file and moving down to the changeset up to and including the tag.

Note: If you don’t have any tag specified in your changelog file, add it by using the tagDatabase Change Type as follows:

<changeSet id="13.1" author="liquibase">
    lt;tagDatabase tag="version_2.0"/>
</changeSet>

Maven configuration

You can configure Liquibase Maven in multiple ways. You can pass arguments like <changeLogFile> in Maven directly in your pom.xml file, in a liquibase.properties file referenced in your POM, as environment variables, or as JVM system properties.

Tip: For more information about the Maven configuration, see Configuring Maven.

Running the `changelogSyncToTagSQL` Maven goal

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

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

mvn liquibase:changelogSyncToTagSQL -Dliquibase.toTag=version_2.0

Note: You can add the liquibase.migrationSqlOutputFile attribute and specify the file to output the migration SQL script. The default file is migrate.sql. If it exists, it will be overwritten. Also, enter the name of the tag that you want to use in place of version_2.0.

Alternatively, you can add the goal and its attributes to the <executions> section of your pom.xml:

<executions>
    <execution>
        <phase>process-resources</phase>
            <goals>
                <goal>changelogSyncToTagSQL</goal>
            </goals>
        <configuration>
            <toTag>version_2.0</toTag>
        </configuration>
    </execution>
</executions>

Output

When successful, the changelogSyncToTagSQL Maven goal produces the following output:

[INFO] Scanning for projects...
[INFO]
[INFO] -------------------< com.example:liquibase-project >--------------------
[INFO] Building liquibase-project 05XII19
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] --- liquibase-maven-plugin:4.3.2:changelogSyncToTagSQL (default-cli) @ liquibase-project ---
[INFO] Liquibase Pro 4.3.2 by Liquibase licensed to support until Wed Sep 22 23:59:59 CDT 2021
[INFO] Liquibase Pro 4.3.2 by Liquibase licensed to support until Wed Sep 22 23:59:59 CDT 2021
[INFO] ####################################################
##   _     _             _ _                      ##
##  | |   (_)           (_) |                     ##
##  | |    _  __ _ _   _ _| |__   __ _ ___  ___   ##
##  | |   | |/ _` | | | | | '_ \ / _` / __|/ _ \  ##
##  | |___| | (_| | |_| | | |_) | (_| \__ \  __/  ##
##  \_____/_|\__, |\__,_|_|_.__/ \__,_|___/\___|  ##
##              | |                               ##
##              |_|                               ##
##                                                ##
##  Get documentation at docs.liquibase.com       ##
##  Get certified courses at learn.liquibase.com  ##
##  Free schema change activity reports at        ##
##      https://hub.liquibase.com                 ##
##                                                ##
####################################################
Starting Liquibase at 03:55:32 (version 4.3.2 #44 built at 2021-03-23 14:01+0000)
[INFO] Char encoding not set! The created file will be system dependent!
[INFO] Output SQL Migration File: C:\Users\Nataliya.WIN-20E107KB4TN\Desktop\Liquibase Projects\Maven Projects\my-liquibase-app\target\liquibase\migrate.sql
[INFO] Parsing Liquibase Properties File local.liquibase.properties for changeLog parameters
[INFO] Executing on Database: jdbc:oracle:thin:@localhost:1521/ORCL
[INFO] Successfully acquired change log lock
[INFO] Reading from DATABASECHANGELOG
[INFO] Successfully released change log lock
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  17.202 s
[INFO] Finished at: 2021-03-31T03:55:40-05:00
[INFO] ------------------------------------------------------------------------

`changelogSyncToTagSQL` required Maven configuration attributes

Attribute	Definition
`liquibase.toTag`	Syncs the changesets up to and including the tag.

`changelogSyncToTagSQL` optional Maven configuration attributes

Attribute	Definition
`liquibase.changeLogDirectory`	Specifies the path to the directory where Liquibase can find your changelog file.
`liquibase.changeLogFile`	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`	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.labels`	Specifies which labels Liquibase runs, and which can be separated by a comma if multiple labels are required or you need to designate a more complex expression. If no label is specified, then all labels are run.
`liquibase.licenseKey`	Specifies your Liquibase Pro license key.
`liquibase.migrationSqlOutputFile`	Specifies the file to output the rollback/migration SQL script to. If it exists, it will be overwritten. Default value is: `${project.build.directory}/liquibase/migrate.sql`.
`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.

Maven changelogSyncToTagSQL

Uses

Maven configuration

Running the changelogSyncToTagSQL Maven goal

changelogSyncToTagSQL required Maven configuration attributes

changelogSyncToTagSQL optional Maven configuration attributes

Maven `changelogSyncToTagSQL`

Running the `changelogSyncToTagSQL` Maven goal

`changelogSyncToTagSQL` required Maven configuration attributes

`changelogSyncToTagSQL` optional Maven configuration attributes