Spring BootでFlywayを使用したMySQLのマイグレーション

どうも高妻です。Twitterでプログラミングのことや暗号通貨のことをつぶやいているのでよかったらフォローしてください。Follow @Tomokazu106

Flywayとは？

FlywayはDBのマイグレーションを行うツールです。DBの状態をバージョン管理でき、ツール経由でSQLを実行するので手作業によるミスを減らすことができます。

1. インストール

Spring BootでのFlywayの導入方法は下記を参考してください。Springスターター・プロジェクトを使うとすごく簡単に導入できます。

EclipseでSpring BootとKotlinの環境構築

2. 使い方

FlywayをSpring Bootで使う場合、resources配下にdb/migrationフォルダを作成して、その中に実行したいSQLファイルを配置していきます。

CREATE TABLE user (
  id INTEGER,
  name CHAR(20),
)

CREATE TABLE user (

id INTEGER,

name CHAR(20),

)

ファイル名にはバージョン情報を含めるので命名に決まりがあります。

V1.0.0__user.sql

上記ファイル名のように__（アンダースコア２つ）の左側がバージョン情報、右側はファイルの中身が分かるように好きに決めていいです。

次にDBへの接続情報をapplication.propertiesに設定します。

spring.datasource.driver-class-name=com.mysql.jdbc.Driver // MySQLのドライバ
spring.datasource.url=jdbc:mysql://localhost:3306/flywaytest //DB名
spring.datasource.username=root // ユーザー名
spring.datasource.password=password // パスワード

spring.datasource.driver-class-name=com.mysql.jdbc.Driver // MySQLのドライバ

spring.datasource.url=jdbc:mysql://localhost:3306/flywaytest //DB名

spring.datasource.username=root // ユーザー名

spring.datasource.password=password // パスワード

MySQL上にDBを作っていない場合は下記コマンドで作成しておいてください。

CREATE DATABASE flywaytest;

1	CREATE DATABASE flywaytest;

3. 実行

設定が完了したらあとはSpringを起動するだけでSQLが実行されてflywaytestにuserテーブルが作成されます。Flywayは同じデータベース内に実行したSQLファイルを記録しているので同じSQLを実行することがないように制御されています。

これで複数人でテーブルを追加しながら開発を行っていても、マージして起動後には同じデータベースの状態にすることができます。

この記事を書いた人
最新の記事

高妻智一

2013年CyberAgent新卒入社スマホゲームを作る子会社に所属し、サーバーサイドのエンジニアを担当。２年目の終わりから新規子会社の立ち上げに参加し、サーバーサイドのエンジニアリーダーとしてサービースのリリースから運用までを担当。現在はTwitterなどSNSのテキスト解析を行うソーシャルメディア分析のサーバーサイドを開発中。言語はNode.js、Kotlinを使用。