Spring Boot Liquibase Application

Background

The example projects demonstrates how to use Spring Boot in combination with Liquibase to manage database change sets. This application can run as part of a build process or as an executable jar.

Running as a Maven Build

This can be helpful as part of your build process during development. Doing a Maven compile with the liquibase profile active along with the required arguments:

mvn compile -Pliquibase -DdbUrl=[dbUrl] -DdbUser=[dbUser] -DdbPwd=[dbPwd] -DdropFirst=[dropFirst]

For example:

mvn compile -Pliquibase -DdbUrl=jdbc:postgresql://localhost:5432/postgres -DdbUser=postgres -DdbPwd=admin -DdropFirst=true

Running as an Executable JAR

When it comes time to go to production, and an installation needs to happen, running as an executable JAR can be a good option.

1. Package the application

mvn package

1. Run the application with the required arguments

java -jar spring-boot-liquibase-1.0-SNAPSHOT.jar --dbUrl=[dbUrl] --dbUser=[dbUser] --dbPwd=[dbPwd] --dropFirst=[dropFirst]

For example:

java -jar target/spring-boot-liquibase-1.0-SNAPSHOT.jar --dbUrl=jdbc:postgresql://localhost:5432/test_db --dbUser=postgres --dbPwd=postgres --dropFirst=true

Database Change Log Tables

This example uses a PostgreSQL database. After the liquibase changes have run two tables will exist in the public schema:

1. databasechangelog - A log of all the liquibase change sets run
2. databasechangeloglock - A table that is checked to get a lock to avoid multiple liquibase instances happening at the same time

Liquibase creates these tables.

Organizing Liquibase Change Set

The application looks at what change sets are in resources/liquibase/master.xml. This application has a simple schema.xml and table.xml for loading schema and table change sets. This could be expanded to have alter scripts, indexing scripts, or whatever you need for your database change sets. How you want to organize those files is entirely up to you. Just know that master.xml is the entry point for all changes.

Using Other Databases

It's simple to use other databases besides PostgreSQL with this application. In the pom.xml locate the PostgreSQL database driver runtime dependency. Replace that with the database driver you need.

<!--Provided, Runtime, and Optional Dependencies Below-->
<dependency>
    <groupId>org.postgresql</groupId>
    <artifactId>postgresql</artifactId>
    <scope>runtime</scope>
</dependency>