Maven `update`

Description

update deploys any changes that are in the changelog file and that have not been deployed to your database yet.

Uses

update is typically used to apply database changes that are specified in the changelog file to your database.

When you run the update goal, Liquibase sequentially reads changesets in the changelog file, then it compares the unique identifiers of id, author, and path to filename to the values stored in the DATABASECHANGELOG table.

If the unique identifiers do not exist, Liquibase will apply the changeset to the database.
If the unique identifiers exist, the MD5Sum of the changeset is compared to the one in the database.
If they are different, Liquibase will produce an error message that someone has changed it unexpectedly. However, if the status of the runOnChange or runAlways changeset attribute is set to TRUE, Liquibase will re-apply the changeset.

Maven configuration

Liquibase Maven can be configured multiple ways. One way is to define your Liquibase configuration properties in your pom.xml file. You can also indicate the location of your liquibase.properties file using the following syntax:

<liquibase.propertyFile>path/to/properties_file</liquibase.propertyFile>

Note: Replace path/to/properties_file with the location of your default properties file. See the example below.

Example: <liquibase.propertyFile>${project.basedir}/local.liquibase.properties</liquibase.propertyFile>

Note: Multiple profiles can be created in the pom.xml which contain different Liquibase properties. See the example below.

Example of a Maven pom.xml output

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                    
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.9.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>liquibase-project</artifactId>
<version>05XII19</version>
    <profiles>
    <profile>
    <id>DEV</id>
    <properties>
                    
<liquibase.propertyFile>${project.basedir}/DEV.properties</liquibase.propertyFile>
    </properties>
</profile>
<profile>
    <id>QA</id>
    <properties>
                    
<liquibase.propertyFile>${project.basedir}/QA.properties</liquibase.propertyFile>
    </properties>
</profile>
<profile>
    <id>PROD</id>
    <properties>
                    
<liquibase.propertyFile>${project.basedir}/PROD.properties</liquibase.propertyFile>
    </properties>
</profile>
</profiles>
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>com.microsoft.sqlserver</groupId>
        <artifactId>mssql-jdbc</artifactId>
        <version>8.1.0.jre8-preview</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/com.oracle.jdbc/ojdbc6 -->
    <dependency>
        <groupId>com.oracle.jdbc</groupId>
        <artifactId>ojdbc8</artifactId>
        <version>19.3.0.0</version>
    </dependency>
</dependencies>
<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.liquibase</groupId>
                <artifactId>liquibase-maven-plugin</artifactId>
                <version>3.8.9</version>

        <!--  <executions>
            <execution>
                <goals>
                    <goal>update</goal>
                </goals>
                <phase>process-classes</phase>
            </execution>
        </executions>-->
    <dependencies>
                    
    <!--Pick ONLY ONE of the following database dependencies.  These are working examples for you to use to start with -->
        <dependency>
            <groupId>com.microsoft.sqlserver</groupId>
            <artifactId>mssql-jdbc</artifactId>
            <version>7.4.1.jre8</version>
        </dependency>
        <dependency>
            <groupId>postgresql</groupId>
            <artifactId>postgresql</artifactId>
            <version>9.1-901-1.jdbc4</version>
        </dependency>
        <dependency>
            <!--  How to add Oracle JDBC driver in your Maven local repository
            https://www.mkyong.com/maven/how-to-add-oracle-jdbc-driver-in-your-maven-local-repository/ -->
            <groupId>com.oracle</groupId>
            <artifactId>ojdbc7</artifactId>
            <version>4.1.3</version>
        </dependency>
    </dependencies>
</plugin>
</plugins>
</pluginManagement>
</build>
</project>

Running the `update` Maven goal

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

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

mvn liquibase:update

Output

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

[INFO] Scanning for projects...
Downloading from plugins-release: https://artifactory.datical.net:80/artifactory/plugins-release/org/eclipse/m2e/lifecycle-mapping/1.0.0/lifecycle-mapping-1.0.0.pom
Downloading from libs-snapshot-local: http://artifactory.datical.net:80/artifactory/libs-snapshot-local/org/eclipse/m2e/lifecycle-mapping/1.0.0/lifecycle-mapping-1.0.0.pom
Downloading from plugins-snapshot: http://artifactory.datical.net:80/artifactory/plugins-snapshot/org/eclipse/m2e/lifecycle-mapping/1.0.0/lifecycle-mapping-1.0.0.pom
Downloading from maven.oracle.com: https://maven.oracle.com/org/eclipse/m2e/lifecycle-mapping/1.0.0/lifecycle-mapping-1.0.0.pom
[WARNING] Failed to retrieve plugin descriptor for org.eclipse.m2e:lifecycle-mapping:1.0.0: Plugin org.eclipse.m2e:lifecycle-mapping:1.0.0 or one of its dependencies could not be resolved: Failed to read artifact descriptor for org.eclipse.m2e:lifecycle-mapping:jar:1.0.0
[INFO]
[INFO] ------------------- <com.example:liquibase-project> --------------------
[INFO] Building liquibase-project 05XII19
[INFO] --------------------------------[ jar ]---------------------------------
[WARNING] Failed to retrieve plugin descriptor for org.eclipse.m2e:lifecycle-mapping:1.0.0: Plugin org.eclipse.m2e:lifecycle-mapping:1.0.0 or one of its dependencies could not be resolved: Failed to read artifact descriptor for org.eclipse.m2e:lifecycle-mapping:jar:1.0.0
[INFO]
[INFO] --- liquibase-maven-plugin:3.8.9:update (default-cli) @ liquibase-project ---
[INFO] ------------------------------------------------------------------------
[INFO] Parsing Liquibase Properties File
[INFO]   File: C:\Users\Nataliya.WIN-20E107KB4TN\Desktop\Liquibase Projects\Maven Projects\my-liquibase-app/local.liquibase.properties
[INFO]   'referencePassword' in properties file is not being used by this task.
[INFO]   'referenceUrl' in properties file is not being used by this task.
[INFO]   'referenceUsername' in properties file is not being used by this task.
[INFO] ------------------------------------------------------------------------
[INFO] Successfully installed license from Base64 string starting with 'ABwwGgQUxS' (property liquibaseProLicenseKey).
[INFO] Liquibase Pro 3.8.9 by Datical licensed to Liquibase Pro Customer until Tue Nov 03 19:00:00 CST 2020
[INFO] Liquibase Pro 3.8.9 by Datical licensed to Liquibase Pro Customer until Tue Nov 03 19:00:00 CST 2020
[INFO] Starting Liquibase at Tue, 11 Aug 2020 12:36:45 CDT (version 3.8.9 #73 built at Mon Apr 06 09:32:58 UTC 2020)
[INFO] Parsing Liquibase Properties File C:\Users\Nataliya.WIN-20E107KB4TN\Desktop\Liquibase Projects\Maven Projects\my-liquibase-app/local.liquibase.properties for changeLog parameters
[INFO] Executing on Database: jdbc:oracle:thin:@localhost:1521:ORCL
[INFO] SELECT COUNT(*) FROM DATABASECHANGELOGLOCK
[INFO] SELECT COUNT(*) FROM DATABASECHANGELOGLOCK
[INFO] SELECT LOCKED FROM DATABASECHANGELOGLOCK WHERE ID=1 FOR UPDATE
[INFO] Successfully acquired change log lock
[INFO] SELECT MD5SUM FROM DATABASECHANGELOG WHERE MD5SUM IS NOT NULL AND ROWNUM=1
[INFO] SELECT COUNT(*) FROM DATABASECHANGELOG
[INFO] Reading from DATABASECHANGELOG
[INFO] SELECT * FROM DATABASECHANGELOG ORDER BY DATEEXECUTED ASC, ORDEREXECUTED ASC
[INFO] CREATE TABLE T_TABLE1000 (ID NUMBER(*, 0) NOT NULL, NAME VARCHAR2(20 BYTE), REGION VARCHAR2(20 BYTE), MARKET VARCHAR2(20 BYTE))
[INFO] Table T_TABLE1000 created
[INFO] ChangeSet dbchangelog.xml::15813::TsviZ ran successfully in 106ms
[INFO] SELECT MAX(ORDEREXECUTED) FROM DATABASECHANGELOG
[INFO] INSERT INTO DATABASECHANGELOG (ID, AUTHOR, FILENAME, DATEEXECUTED, ORDEREXECUTED, MD5SUM, DESCRIPTION, COMMENTS, EXECTYPE, CONTEXTS, LABELS, LIQUIBASE, DEPLOYMENT_ID) VALUES ('15813', 'TsviZ', 'dbchangelog.xml', SYSTIMESTAMP, 13, '8:2976d48b6ef8319cd030a74a3e9c533d', 'createTable tableName=T_TABLE1000', '', 'EXECUTED', NULL, NULL, '3.8.9', '7167413355')
[INFO] Successfully released change log lock
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  18.124 s
[INFO] Finished at: 2020-08-11T12:36:53-05:00
[INFO] ------------------------------------------------------------------------

`update` Optional Maven configuration properties

Property	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.changesToApply [int]	Specifies the number of changes to apply to the database. By default this value is 0, which will result in all changes (not already applied to the database) being applied.
liquibase.clearCheckSums [boolean]	A flag that 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.dropFirst [boolean]	Specifies whether to perform a drop on the database before executing the change. Default value is: false.
liquibase.emptyPassword [boolean]	Deprecated. Use an empty or null value for the password instead. Default value is: false.
expressionVariables	A map-based collection of changelog properties to apply.
expressionVars	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.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. Default value is: `INFO`.
liquibase.outputDefaultCatalog [boolean]	Specifies whether to ignore the catalog/database name. Default value is: false.
liquibase.outputDefaultSchema [boolean]	Specifies whether to ignore the schema name. Default value is: false.
liquibase.outputFileEncoding	A flag which indicates you want to set the character encoding of the output file during the `updateSQL` phase.
liquibase.password	Specifies the database password for 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]	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	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 parameter 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.toTag	Update to the changesets with the given tag command.
liquibase.url	Specifies the database URL you want to use to execute Liquibase.
liquibase.username	Specifies the database username for database connection.
liquibase.verbose [boolean]	Controls the amount of output detail when you call the plugin. Default value is: false.

Maven update