Java アプリ用のデータベース移行の実行

最終更新日 2020年06月05日(金)

Liquibase の使用
Flyway の使用
参考資料

ほとんどのデータベース支援型アプリケーションでは、運用の途中でそのデータベーススキーマを変更することが必要になります。これらの変更は、多くの場合、移行 (migration) または進化 (evolution) と呼ばれるプロセスによって制御されます。

この記事では、Liquibase と Flyway の 2 つのツールを使用して、Heroku で Java アプリケーションのデータベース移行を実行する方法を学びます。

Liquibase の使用

Liquibase には多くの実行方法があります。Maven プラグイン、スタンドアロンのコマンドラインツール、Hibernate プラグイン、および Spring Bean が提供されています。この記事では、Heroku で使用する最適なメカニズムについて説明します。

Spring を使用した Liquibase の自動実行

Liquibase では、非常に便利な SpringLiquibase Bean を提供しています。この Bean は、正しい場所に移行がある場合、起動時に移行を自動的に実行します。

Spring Boot を使用している場合、必要な手順は、この Spring と Liquibase のサンプルアプリケーションで示しているように、liquibase-core 依存関係をインクルードして変更ログを src/resources/db/changelog/db.changelog-master.yaml に配置するのみです。

起動すると、次のような情報がログに出力されます。

2015-10-20T02:00:51.937179+00:00 app[web.1]: 2015-10-20 02:00:51.936  INFO 3 --- [main] liquibase : Successfully acquired change log lock
2015-10-20T02:00:55.419669+00:00 app[web.1]: 2015-10-20 02:00:55.419  INFO 3 --- [main] liquibase : Reading from public.databasechangelog
2015-10-20T02:00:55.571104+00:00 app[web.1]: 2015-10-20 02:00:55.555  INFO 3 --- [main] liquibase : Successfully released change log lock

ただし、起動時に移行を実行すると、アプリの起動時間が長くなり、Heroku で規定されているブートタイムアウト制限を超過する可能性があります。その場合は、Heroku リリースフェーズで移行を実行する方が適切である可能性があります。

Maven プラグインを使用した Liquibase の実行

次のプラグイン設定を pom.xml に追加することにより、Heroku リリースフェーズで Liquibase Maven プラグインを使用して Liquibase の移行を実行できます。

<plugin>
  <groupId>org.liquibase</groupId>
  <artifactId>liquibase-maven-plugin</artifactId>
  <configuration>
    <changeLogFile>src/main/resources/db/changelog/db.changelog-master.yaml</changeLogFile>
    <url>${env.JDBC_DATABASE_URL}</url>
  </configuration>
</plugin>

次に、プロジェクトで Maven Wrapper を使用していることを確認します。まだ使用していない場合、次のように実行することで追加できます。

$ mvn -N io.takari:maven:wrapper
$ git add mvnw .mvn
$ git commit -m "Added maven wrapper"

これが準備ができたら、デプロイのリリースフェーズで移行を実行するプロセスエントリを Procfile に追加できます。

release: ./mvnw liquibase:update

ただし、Maven .m2 キャッシュはアプリの slug に含まれていないため、リリースフェーズの実行のたびに Liquibase の依存関係をすべてダウンロードする必要があります。そのオーバーヘッドが大きすぎる場合、Maven を使用せずに Liquibase を実行することもできます。

コマンドラインツールを使用した Liquibase の実行

Liquibase のコマンドラインツールを使用して、Heroku リリースフェーズで Liquibase の移行を実行できます。このツールを使用するには、次のプラグイン設定を Maven の pom.xml に追加することによって、Liquibase の JAR ファイルを slug にインクルードする必要があります。

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-dependency-plugin</artifactId>
  <executions>
    <execution>
      <id>copy-dependencies</id>
      <phase>package</phase>
      <goals><goal>copy</goal></goals>
      <configuration>
        <artifactItems>
          <artifactItem>
            <groupId>org.liquibase</groupId>
            <artifactId>liquibase-core</artifactId>
            <version>3.4.1</version>
            <destFileName>liquibase.jar</destFileName>
          </artifactItem>
          <artifactItem>
            <groupId>org.yaml</groupId>
            <artifactId>snakeyaml</artifactId>
            <version>1.13</version>
            <outputDirectory>${project.build.directory}/dependency/lib</outputDirectory>
          </artifactItem>
          <artifactItem>
            <groupId>org.postgresql</groupId>
            <artifactId>postgresql</artifactId>
            <version>9.4-1204-jdbc41</version>
            <destFileName>postgres.jar</destFileName>
          </artifactItem>
        </artifactItems>
      </configuration>
    </execution>
  </executions>
</plugin>

これにより、Maven の package ゴールの間に JAR ファイルが target/dependency/liquibase.jar にコピーされます。これが準備できたら、デプロイのリリースフェーズで移行を実行するプロセスエントリを Procfile に追加できます。

release: java -jar target/dependency/liquibase.jar --changeLogFile=src/main/resources/db/changelog/db.changelog-master.yaml --url=$JDBC_DATABASE_URL --classpath=target/dependency/postgres.jar update

Java 用の移行エンジンは Liquibase のみではありません。Flyway も使用できます。

Flyway の使用

Flyway では、移行を実行するためのメカニズムとして、コマンドラインツール、Maven プラグイン、Gradle プラグイン、SBT プラグインなどが提供されています。この記事では、Heroku で使用する最適なメカニズムについて説明します。

Spring を使用した Flyway の自動実行

この Spring と Flyway のサンプルアプリケーションで示しているように、flyway-core 依存関係をアプリにインクルードし、移行スクリプトを src/main/resources/db/migration/ に配置することによって Flyway を自動的に実行できます。

ただし、起動時に移行を実行すると、アプリの起動時間が長くなり、Heroku で規定されているブートタイムアウト制限を超過する可能性があります。その場合は、Heroku リリースフェーズから移行を実行する方が適切である可能性があります。

Maven プラグインを使用した Flyway の実行

Heroku のリリースフェーズから Flyway Maven プラグインを実行することもできます。まず、次のようにプラグインを pom.xml に追加します。

<plugin>
  <groupId>org.flywaydb</groupId>
  <artifactId>flyway-maven-plugin</artifactId>
  <configuration>
    <url>${env.JDBC_DATABASE_URL}</url>
  </configuration>
</plugin>

次に、プロジェクトで Maven Wrapper を使用していることを確認します。まだ使用していない場合、次のように実行することで追加できます。

$ mvn -N io.takari:maven:wrapper
$ git add mvnw .mvn
$ git commit -m "Added maven wrapper"

これが準備ができたら、デプロイのリリースフェーズで移行を実行するプロセスエントリを Procfile に追加できます。

release: ./mvnw flyway:migrate

ただし、Maven .m2 キャッシュはアプリの slug に含まれていないため、リリースフェーズの実行のたびに Flyway の依存関係をすべてダウンロードする必要があります。そのオーバーヘッドが大きすぎる場合、Maven を使用せずに Flyway を実行することもできます。

Java API を使用した Flyway の実行

Flyway Java API を使用するには、次のように、main メソッドを持つ単純なクラスを作成します。

package sample.flyway;

import org.flywaydb.core.Flyway;

public class Migrations {
    public static void main(String[] args) throws Exception {
        Flyway flyway = new Flyway();
        flyway.setDataSource(System.getenv("JDBC_DATABASE_URL"),
                             System.getenv("JDBC_DATABASE_USERNAME"),
                             System.getenv("JDBC_DATABASE_PASSWORD"));
        flyway.migrate();
    }
}

それから、次のプラグイン設定を pom.xml ファイルに追加することによって、Flyway の JAR ファイルを slug ファイルにコピーします。

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-dependency-plugin</artifactId>
  <executions>
    <execution>
      <id>copy-dependencies</id>
      <phase>package</phase>
      <goals><goal>copy</goal></goals>
      <configuration>
        <artifactItems>
          <artifactItem>
            <groupId>org.flywaydb</groupId>
            <artifactId>flyway-core</artifactId>
            <version>3.2.1</version>
            <destFileName>flyway.jar</destFileName>
          </artifactItem>
          <artifactItem>
            <groupId>org.postgresql</groupId>
            <artifactId>postgresql</artifactId>
            <version>9.4-1204-jdbc41</version>
            <destFileName>postgres.jar</destFileName>
          </artifactItem>
        </artifactItems>
      </configuration>
    </execution>
  </executions>
</plugin>

これにより、Maven の package ゴールの間に JAR ファイルが target/dependency/flyway.jar にコピーされます。これが準備できたら、移行を実行するプロセスエントリを Procfile に追加できます。

release: java -cp target/spring-boot-sample-flyway-1.0.0.jar:target/dependency/* sample.flyway.Migrations

これにより、Heroku リリースフェーズの間に移行が実行されます。次のコマンドを使用して、手動で移行を実行することもできます。

$ heroku run release

参考資料

詳細は、以下の各オープンソースプロジェクトの公式ドキュメントページを参照してください。

Dev Center の「Java を使用して Heroku でリレーショナルデータベースに接続する」の記事も参照してください。

Categories