Maven LiquiBase プラグイン

LiquiBase は、Maven リポジトリから入手できる Maven プラグインから制御することができます。

LiquiBase-core と Maven プラグインは、 こちら からすべてのバージョンが利用可能です。

プラグインの設定は、pom.xml ファイルの <plugins> セクションで行います、設定と実行フェーズを記述します。

それぞれのゴールに応じて、設定パラメータがありますが、そのうちのいくつかは上記例であるとおり、両者で共通になっています。設定パラメータについて詳細を知りたい場合は、ゴールからのリンクを参照してください。

Maven プラグインのバージョン 1.6.1.0 では、すべてのファイル名は Maven プロジェクトのmaven test クラスパスか絶対パスによって解決されます。これにより、DatabaseChangeLog がほかの Maven artifacts にも現れるようになり、データベースの LiquiBase を呼び出すことができます。

Maven LiquiBase プラグインでの設定は、標準的な Java プロパティファイルを元に行うことができます。もし、プロパティファイルが指定されていれば、Maven LiquiBase プラグインの起動時にこれを利用します。

ファイルに指定されたそれぞれのプロパティがゴールと合致している場合には設定されます。もし、プロパティがゴールと合致していない場合は、警告が表示され、実行は継続されます。

警告を表示するだけになっている理由は、ユーザーが単一のマスタープロパティファイルを利用して複数の Maven Liquibase ゴール、たとえば liquibase:update や liquibase:tag に対応できるようにするためです。

プロパティは、LiquiBase プロパティファイルと <configuration> の両方で指定できます。

<configuration> セクションでプロパティが指定された場合は、プロパティファイルで指定されたものを上書きして指定します。

この動作がお好みでなければ、<configuration> セクションに、

<propertyFileWillOverride>true</propertyFileWillOverride>

を追加することでプロパティファイルが、<configuration> セクションの記述より優先されるようになります。

下記の設定例は、 LiquiBase Maven プラグイン、バージョン 1.6.1.0 のもので、liquibase:update ゴールの例を示しています;

  <project>
    [...]
    <build>
      <plugins>
        <plugin>
          <groupId>org.liquibase</groupId>
          <artifactId>liquibase-plugin</artifactId>
          <version>1.6.1.0</version>
          <executions>
            <execution>
              <phase>process-resources</phase>
              <configuration>
                <propertyFile>src/main/resources/liquibase.properties</propertyFile>
              </configuration>
              <goals>
                <goal>update</goal>
              </goals>
            </execution>
          </executions>
        </plugin>
      </plugins>
    </build>
    [...]
  </project>

上記の設定例では、 liquibase:update を実行し、ビルドの process-resource フェーズを達成します。LiquiBase を実行するためのパラメータ (database url,password, 等々)は、src/main/resources/liquibase.properties で設定されます。

src/main/resources/liquibase.properties ファイルへのパスは、そのファイルがクラスパスにあれば短縮できます。

LiquiBase を実行するためのすべてのパラメータは、プラグインの<configuration> セクションで指定します。下記がその例です:

  [...]
    <plugin>
      <groupId>org.liquibase</groupId>
      <artifactId>liquibase-plugin</artifactId>
      <version>1.6.1.0</version>
      <executions>
        <execution>
          <phase>process-resources</phase>
          <configuration>
            <changeLogFile>src/main/resources/org/liquiabse/business_table.xml</changeLogFile>
            <driver>oracle.jdbc.driver.OracleDriver</driver>
            <url>jdbc:oracle:thin:@tf-appserv-linux:1521:xe</url>
            <username>liquibaseTest</username>
            <password>pass</password>
          </configuration>
          <goals>
            <goal>update</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  [...]

<promptOnNonLocalDatabase>false</promptOnNonLocalDatabase>

を設定パラメータに追加すると、ローカルでないデータベースでの移行を確認するポップアップダイアログが抑止できます。

maven コマンド

mvn help:describe -DgroupId=org.liquibase -DartifactId=liquibase-plugin -Dversion=1.7.0.0 -Dfull=true

を設定すると、LiquiBase maven プラグインで利用できる全ての設定パラメータへのヒントが表示されます。

parent-pom ( company super-pom とも呼ばれます) の利用を通じて、集中された Liquibase プラグイン設定をすべての Maven 子プロジェクトに適用可能です。super-pom の概要に関する詳細な説明は、see Maven manual Pom section を参照して下さい。

この設定を行うと、プラグイン設定は、super-pom に記述され、すべての子プロジェクトから利用可能になります。各プロジェクトでのニーズ ( データベースドライバ、JDBC URL 等) への対応は、ローカルの liquibase.properties ファイルを通じて行われます。さらに、いくつかの設定がプロジェクト内で行う必要がある場合、liquibase.properties は、Maven リソースフィルタリングシステムによってフィルターさせることも可能です。

Parent pom.xml 設定:

  <project>
    [...]
    <build>
      <plugins>
        <plugin>
          <groupId>org.liquibase</groupId>
          <artifactId>liquibase-plugin</artifactId>
          <version>x.x.x.x</version>
          <configuration>
            <propertyFileWillOverride>true</propertyFileWillOverride>
            <propertyFile>target/classes/liquibase.properties</propertyFile>
          </configuration>
        </plugin>
      </plugins>
    </build>
    [...]
  </project>

x.x.x.x をもっとも最新のプラグインバージョンに変更しましょう。 上記にあるように、<executions> セクションを追加するか、<configuration> セクションにさらなる設定情報を追加します。どんな変更でも全ての子プロジェクトに反映されることを忘れないで下さい。ある程度であれば、<propertyFileWillOverride> を true に変更することで、グローバルの設定を、ローカルにある liquibase.properties ファイルによって置き換えることも可能です。プロジェクトに対して多少の例外を除いてグローバル設定を使用したい場合、常に<plugin> セクションを子の pom.xml に追加することもでき、これによりグローバル設定が上書きされます。

db.changelog.xml だけでなく、liquibase.properties も、src/main/resources フォルダになければなりません。必要なだけ多くのプロパティを保持することができます。ここでは、完全な設定例を記述します:

contexts ${liquibase.contexts} 
changeLogFile com/company/client/project/db.changelog.xml 
driver ${dataSource.project.driverClass} 
url ${dataSource.project.jdbcURL} 
username ${dataSource.project.user} 
password ${dataSource.project.password} 
verbose true 
dropFirst false 

そのプレースホルダは、Maven のリソースフィルタリングシステムにより、置換されます。Maven の通常の resources/ フォルダを置き換えるには、”pom.xml” ファイルに下記のように記述するだけです:

<build>
    <resources>
      <resource>
        <directory>src/main/resources</directory>
        <filtering>true</filtering>
      </resource>
    </resources>
</build>

詳細は How do I filter resource files を参照してください。

その特定の設定、プロジェクトの jdbc url、データベースドライバ、ユーザー名とパスワードは、Liquibase でも利用されます。 そのプレースホルダは、src/main/filters に存在するプロパティファイルの値で置き換えられます。 必要なだけいくらでもプロパティファイルフィルタを作成することができます。Maven の実行時に利用されるフィルタを特定するには、Maven profiles を利用する必要があります。 典型的な実行例はこのようになります:

mvn resources:resources liquibase:update -P<profile_name>

liquibase.properties プレースホルダーをフィルタ＝するのに、resources を実行する必要があります。”-P” オプションは、Maven に利用するプロファイルを示し、( フィルタープロパティファイルから ) 値のまとまりを利用してフィルタリングします。

フィルタリングを行う必要がない場合、super-pom プラグイン設定を

<propertyFile>target/classes/liquibase.properties</propertyFile>

から

<propertyFile>src/main/resources/liquibase.properties</propertyFile>

に置き換えます。

実行も、単純に

mvn liquibase:update

にします。

この設定方法による主なメリットは:

• プロジェクトで Liquibase プラグインの設定が不要。”liquibase.properties” だけが必要。
• プラグインバージョン更新を行う場所が一意に特定可能 ( すべての “pom.xml” ファイルを手動で編集し、コミットする必要がありません。)