Spring BootでFlywayを使ったマイグレーション - 親バカエンジニアのナレッジ帳

Spring Bootのマイグレーション

開発をするにあたってDBのバージョン管理をしっかりするためにもマイグレーションは必要です。
Spring Bootでは、Flywayを使えばとても楽にマイグレーションを行うことができます。

※この手順では、application.ymlなどに以下のような設定があり、データベースとの接続設定は完了しているものとします。

例）

spring:
  datasource:
    url: jdbc:mysql://localhost/test-database?useSSL=false&characterEncoding=UTF-8
    username: root
    password: root
    driverClassName: com.mysql.jdbc.Driver

Flywayライブラリの追加

まず、Flywayライブラリを使うためにpom.xmlに以下を追加してください。

<dependency>
    <groupId>org.flywaydb</groupId>
    <artifactId>flyway-core</artifactId>
</dependency>

もちろんMavenの再読み込みは忘れずに。

マイグレーションパッケージ、ファイルの作成

次に、src/main/resourcesにdb.migrationパッケージを作成してください。

これで準備OKです。
めちゃめちゃ簡単ですね。

マイグレーションファイルは、「V + バージョン番号__任意のファイル名.sql」といった形式で作成してください。
例えば以下のようになります。
V1__create-users.sql
V2__create-products.sql
V3__alter-users.sql

任意のファイル名の箇所は本当に何でも良いですが、後で見た時に意味がわかるようなファイル名にしておきましょう。
マイグレーションファイルは、開発を重ねるほどどんどん増えていくため、内容によってファイル名のルールを決めておくと良いでしょう。

例としてUsersテーブルを作成するマイグレーションファイルを作成します。

V1__create-users.sql

create table users (
    id integer primary key,
    mail_address varchar(255),
    password char(30),
    updated_at timestamp not null default current_timestamp,
    created_at timestamp not null default current_timestamp
);