Table of Contents

Schema Migration with Liquibase

Learn how to use the Liquibase to manage your schema migrations.

Authors: Sergio del Amo

Micronaut Version: 4.6.3

1. Getting Started

In this guide, we will create a Micronaut application written in Groovy.

2. What you will need

To complete this guide, you will need the following:

3. Solution

We recommend that you follow the instructions in the next sections and create the application step by step. However, you can go right to the completed example.

Create an application using the Micronaut Command Line Interface or with Micronaut Launch.

mn create-app
   example.micronaut.micronautguide \
   --features=data-jdbc,postgres,liquibase \
   --build=gradle \
   --lang=groovy \
If you don’t specify the --build argument, Gradle with the Kotlin DSL is used as the build tool.
If you don’t specify the --lang argument, Java is used as the language.
If you don’t specify the --test argument, JUnit is used for Java and Kotlin, and Spock is used for Groovy.

The previous command creates a Micronaut application with the default package example.micronaut in a directory named micronautguide.

If you use Micronaut Launch, select "Micronaut Application" as application type and add postgres, data-jdbc, and liquibase as features.

Setup IntelliJ IDEA to develop Micronaut Applications.

3.1. Create Entity

Create a @MappedEntity to save persons. Initially, consider name and age required. Use int primitive for the age.

src/main/groovy/example/micronaut/Person.groovy
package example.micronaut


import groovy.transform.CompileStatic
import io.micronaut.core.annotation.NonNull
import io.micronaut.core.annotation.Nullable
import io.micronaut.data.annotation.GeneratedValue
import io.micronaut.data.annotation.Id
import io.micronaut.data.annotation.MappedEntity
import io.micronaut.data.annotation.Version

import jakarta.validation.constraints.NotBlank

@CompileStatic
@MappedEntity (1)
class Person {

    @Id (2)
    @GeneratedValue (3)
    Long id

    @Version (4)
    Long version

    @NonNull
    @NotBlank
    final String name

    final int age

    Person(@NonNull String name, int age) {
        this.name = name
        this.age = age
    }

}
1 Annotate the class with @MappedEntity to map the class to the table defined in the schema.
2 Specifies the ID of an entity
3 Specifies that the property value is generated by the database and not included in inserts
4 Annotate the field with @Version to enable optimistic locking for your entity.

3.2. Database Migration with Liquibase

We need a way to create the database schema. For that, we use Micronaut integration with Liquibase.

Add the following snippet to include the necessary dependencies:

build.gradle
implementation("io.micronaut.liquibase:micronaut-liquibase")

Configure the database migrations directory for Liquibase in application.properties.

src/main/resources/application.properties
liquibase.datasources.default.change-log=classpath\:db/liquibase-changelog.xml

Create the following files with the database schema creation:

src/main/resources/db/liquibase-changelog.xml
<?xml version="1.0" encoding="UTF-8"?>
<databaseChangeLog
    xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.1.xsd">

    <include file="changelog/01-create-person.xml"
             relativeToChangelogFile="true"/>

    <include file="changelog/02-nullable-age.xml"
             relativeToChangelogFile="true"/>

</databaseChangeLog>
src/main/resources/db/changelog/01-create-person.xml
<?xml version="1.0" encoding="UTF-8"?>
<databaseChangeLog
    xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.1.xsd">

    <changeSet id="01" author="sdelamo">

        <createTable tableName="person"
                     remarks="A table to contain persons">

            <column name="id" type="BIGINT">
                <constraints nullable="false"
                             unique="true"
                             primaryKey="true"
                             primaryKeyName="personPK"/>
            </column>

            <column name="version" type="BIGINT">
                <constraints nullable="false"/>
            </column>

            <column name="age" type="INT">
                <constraints nullable="false"/>
            </column>

        </createTable>

    </changeSet>

</databaseChangeLog>

During application startup, Liquibase executes the SQL file and creates the schema needed for the application.

If you check the database schema, there are three tables:

  • databasechangelog

  • databasechangeloglock

The tables databasechangelog and databasechangeloglock are used by Liquibase to keep track of database migrations.

The person table looks like:

Column Nullable

id

NO

version

NO

name

NO

age

NO

3.3. Drop Not Null Constraint

Applications change. Make age optional:

src/main/groovy/example/micronaut/Person.groovy
    @Nullable
    final Integer age

    Person(@NonNull String name,
           @Nullable Integer age) {
        this.name = name
        this.age = age
    }

Add a new changeset to drop the null constraint:

src/main/resources/db/liquibase-changelog.xml
<?xml version="1.0" encoding="UTF-8"?>
<databaseChangeLog
    xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.1.xsd">

    <include file="changelog/01-create-person.xml"
             relativeToChangelogFile="true"/>

    <include file="changelog/02-nullable-age.xml"
             relativeToChangelogFile="true"/>

</databaseChangeLog>
src/main/resources/db/changelog/02-nullable-age.xml
<?xml version="1.0" encoding="UTF-8"?>
<databaseChangeLog
    xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.1.xsd">

    <changeSet id="02" author="sdelamo">
        <dropNotNullConstraint tableName="person"
                               columnName="age"/>
    </changeSet>

</databaseChangeLog>

After the changeset, the person table looks like:

Column Nullable

id

NO

version

NO

name

NO

age

YES

4. Liquibase

To enable the Liquibase endpoint, add the management dependency on your classpath.

build.gradle
implementation("io.micronaut:micronaut-management")

Enable the Liquibase endpoint:

src/main/resources/application.properties
endpoints.liquibase.sensitive=false

5. Test Resources

When the application is started locally — either under test or by running the application — resolution of the datasource URL is detected and the Test Resources service will start a local PostgreSQL docker container, and inject the properties required to use this as the datasource.

For more information, see the JDBC section of the Test Resources documentation.

5.1. Test

Create a test that invokes the Liquibase endpoint

src/test/groovy/example/micronaut/LiquibaseEndpointSpec.groovy
package example.micronaut

import io.micronaut.core.type.Argument
import io.micronaut.http.HttpRequest
import io.micronaut.http.HttpResponse
import io.micronaut.http.client.BlockingHttpClient
import io.micronaut.http.client.HttpClient
import io.micronaut.http.client.annotation.Client
import io.micronaut.serde.annotation.Serdeable
import io.micronaut.test.extensions.spock.annotation.MicronautTest
import jakarta.inject.Inject
import spock.lang.Specification

import static io.micronaut.http.HttpStatus.OK

@MicronautTest (1)
class LiquibaseEndpointSpec extends Specification {

    @Inject
    @Client('/')  (2)
    HttpClient httpClient

    void migrationsAreExposedViaAndEndpoint() {
        given:
        BlockingHttpClient client = httpClient.toBlocking()

        when:
        HttpResponse<List<LiquibaseReport>> response = client.exchange(
                HttpRequest.GET('/liquibase'),
                Argument.listOf(LiquibaseReport)
        )

        then:
        OK == response.status()

        when:
        LiquibaseReport liquibaseReport = response.body().get(0)

        then:
        2 == liquibaseReport?.changeSets?.size()
    }

    @Serdeable
    static class LiquibaseReport {
        List<ChangeSet> changeSets
    }

    @Serdeable
    static class ChangeSet {
        String id
    }
}
1 Annotate the class with @MicronautTest so the Micronaut framework will initialize the application context and the embedded server. More info.
2 Inject the HttpClient bean and point it to the embedded server.

5.2. Running the application

Although the URL is configured automatically via Test Resources, we must configure the PostgreSQL driver and dialect in application.properties:

src/main/resources/application.properties
(1)
datasources.default.driver-class-name=org.postgresql.Driver
(2)
datasources.default.dialect=POSTGRES
(3)
datasources.default.schema-generate=NONE
1 Use PostgreSQL driver.
2 Configure the PostgreSQL dialect.
3 You handle database migrations via Liquibase

To run the application, use the ./gradlew run command, which starts the application on port 8080.

You can run a cURL command to test the application:

curl http://localhost:8080/liquibase

You will see information about migrations.

You can run a cURL command to test the application:

curl http://localhost:8080/liquibase

You will see information about migrations.

6. Next Steps

Explore more features with Micronaut Guides.

Check Micronaut Liquibase integration.

7. Help with the Micronaut Framework

The Micronaut Foundation sponsored the creation of this Guide. A variety of consulting and support services are available.

8. License

All guides are released with an Apache license 2.0 license for the code and a Creative Commons Attribution 4.0 license for the writing and media (images…​).