Liquibase starters for Maven

Liquibase starters for Maven are preconfigured Maven artifacts that bundle Liquibase dependencies and configuration to help you quickly set up Liquibase in a Maven-based project. Rather than manually maintaining a list of individual dependencies and configuring the Liquibase Maven plugin from scratch in your pom.xml file, you can add a single Liquibase starter dependency to include everything you need for a specific Liquibase version automatically. This convenience package simplifies initial setup, ensures compatible dependency versions, and reduces configuration overhead and potential version conflicts. Once the maven starters are installed, you will be able to use the following Liquibase extensions in Maven. These are the two Liquibase starters:

liquibase-secure-starter - contains
- com.liquibase:liquibase-commercial
liquibase-secure-starter-all - contains extensions with their database drivers embedded directly into each extension artifact (shaded), so you don't need to manage driver dependencies separately
- com.liquibase : liquibase-commercial
- com.liquibase.ext : liquibase-commercial-bigquery
- com.liquibase.ext : liquibase-commercial-mongodb
- com.liquibase.ext : liquibase-commercial-databricks
- com.liquibase.ext : liquibase-aws-extension
- com.liquibase.ext.vaults : liquibase-hashicorp-vault
- com.liquibase.ext : liquibase-azure
- com.liquibase.ext : liquibase-checks

Before you begin

Ensure Liquibase Secure 5.1+ is installed on your machine
Ensure Maven is installed on your machine
Ensure you have your Liquibase Secure License key applied
Ensure your liquibase.properties file is configured

Procedure

Open your pom.xml file

This file defines your project's dependencies and plugins.

Add this code to your pom file

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.liquibase</groupId>
  <artifactId>spring-maven-example</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <name>spring-maven-example</name>
  <description>spring-maven-example</description>
  <url/>
  <dependencies>
    <!-- Any existing user's dependencies -->
    <!-- Add this below if you want to use the java api -->
    <dependency>
      <groupId>com.liquibase</groupId>
      <artifactId>liquibase-secure-starter-all</artifactId>
      <version>5.1.0</version>
    </dependency>
  </dependencies>
  <build>
    <plugins>
      <!-- Any existing user's plugins -->
      <plugin>
        <groupId>com.liquibase</groupId>
        <artifactId>liquibase-maven-plugin</artifactId>
        <version>5.0.1</version>
        <configuration>
          <propertyFile>liquibase.properties</propertyFile>
        </configuration>
        <dependencies>
          <dependency>
            <!-- Add this below if you want to use the starts with the maven plugin -->
            <groupId>com.liquibase</groupId>
            <artifactId>liquibase-secure-starter-all</artifactId>
            <version>5.1.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

Run the Maven goal in your terminal to verify the installation was successful

mvn liquibase:status

Results

Notice in your CLI log the version of Liquibase: 5.1.0

Example CLI output:

[INFO] Scanning for projects... [INFO] [INFO] -------------------< com.example:liquibase-project >-------------------- [INFO] Building Liquibase Secure Project 1.0 [INFO] from pom.xml [INFO] --------------------------------[ jar ]--------------------------------- [INFO] [INFO] --- liquibase:5.1.:status (default-cli) @ liquibase-project --- [INFO] ------------------------------------------------------------------------