R2DBC migration tool

Inspired by this announcement.

R2DBC page.

Supported databases

• PostgreSQL
• Microsoft SQL Server
• MySQL
• H2

It also supports user-provided dialect. You can pass implementation of SqlQueries interface to the migrate() method. If you use Spring Boot, just define a bean of type SqlQueries. Example SimplePostgresqlDialect.

Features

• Convention-based file names, for example V3__insert_to_customers__split,nontransactional.sql
• It waits until database have been started, there is test query, and validation result of. This can be useful to initial load data into database with docker-compose
• Supports migrations files larger than -Xmx: file will be splitted line-by-line (split modifier), then it will be loaded by chunks into database
• Lock support, that make you able to start number of replicas your microservice, without care of migrations will collide each other
• Each migration runs in the separated transaction
• It also supports nontransactional migrations, due to SQL Server prohibits CREATE DATABASE in the transaction
• Docker image
• First-class Spring Boot integration, see example below
• Also you can use this library without Spring (Boot) see library example below
• This library tends to be non-invasive, consequently it intentionally doesn't try to parse SQL and make some decisions relying on. So (in theory) you can freely update database and driver's version

All available configuration options are in R2dbcMigrateProperties class. Their descriptions are available in your IDE Ctrl+Space help or in spring-configuration-metadata.json file.

Download

Docker

docker pull nkonev/r2dbc-migrate:latest

Spring Boot Starter

<dependency>
  <groupId>name.nkonev.r2dbc-migrate</groupId>
  <artifactId>r2dbc-migrate-spring-boot-starter</artifactId>
  <version>VERSION</version>
</dependency>

Only library

<dependency>
    <groupId>name.nkonev.r2dbc-migrate</groupId>
    <artifactId>r2dbc-migrate-core</artifactId>
    <version>VERSION</version>
</dependency>

If you use library, you need also use some implementation of r2dbc-migrate-resource-reader-api, for example:

<dependency>
    <groupId>name.nkonev.r2dbc-migrate</groupId>
    <artifactId>r2dbc-migrate-resource-reader-reflections</artifactId>
    <version>VERSION</version>
</dependency>

See Library example below.

Standalone application

If you want to build your own docker image you will be able to do this

curl -Ss https://repo.maven.apache.org/maven2/name/nkonev/r2dbc-migrate/r2dbc-migrate-standalone/VERSION/r2dbc-migrate-standalone-VERSION.jar > /tmp/migrate.jar

Spring Boot Example

https://github.com/nkonev/r2dbc-migrate-example

Library example

https://github.com/nkonev/r2dbc-migrate-example/tree/library