Liquibase

実行構成オプション

基本設定

IntelliJ IDEA では以下を指定できます:

• 使用したい Liquibase のバージョン

• 変更セットの作成者名

• デフォルトのファイルタイプ。 次の 4 つのファイルタイプがサポートされています。

  • XML

  • SQL

  • YAML

  • JSON

変更ログテンプレート

空または差分の Liquibase 変更ログが作成されるたびに、IntelliJ IDEA はテンプレートに基づいてファイル名を生成します。 変更ログのプライマリ / セカンダリディレクトリと名前を設定できます。

正確な構成には、次の変数とマクロが使用できます。

• #increment(<start>, <step>, <decimalFormat>) ：数値シーケンスを使ってバージョンを生成します。

  • start ：最初のマイグレーションのバージョン番号

  • step ：各バージョン番号を増やす値

  • decimalFormat ：バージョン番号のフォーマットに使用される DecimalFormat パターン

• #date(<simpleDateFormat>) ：現在のシステム日付を使ってバージョンを生成します。

  • simpleDateFormat ：日付のフォーマットに使用される SimpleDateFormat パターン

• ${semVer.<getterMethod>} ：プロジェクトのビルドファイルの セマンティックバージョンを使ってバージョンを生成します。

  • getterMethod ：セマンティックバージョンの特定セグメントを抽出するメソッドです。 1.2.3-SNAPSHOT+build4 バージョンの例はこちら：

    • ${semVer.getRawVersion()} ：1.2.3-SNAPSHOT+build4

    • ${semVer.getMajor()}: 1

    • ${semVer.getMinor()}: 2

    • ${semVer.getPatch()}: 3

    • ${semVer.getPreRelease()}: SNAPSHOT

Db タイプ

ソフトウェアでは、いくつかの DBMS タイプのサポートを提供する必要がある場合があります。 この場合、DDL 変更を宣言するための DB 間ソリューションを提供する Liquibase が最適な選択肢です。 IntelliJ IDEA もこのソリューションをサポートしています。 DB 間変更ログを生成するときに、Liquibase プロパティを使用して各 DBMS の正しいデータ型を指定します。

異なる DBMS に対して個別の変更ログを作成する必要はありません。

変更セットテンプレート

変更セットテンプレートは、Liquibase を使用してデータベーススキーマの変更を指定するための標準化された形式を提供する事前定義された構造です。 これらのテンプレートは、一貫性があり再利用可能な変更セットを作成するための基盤として機能し、データベースデプロイ全体の統一性とメンテナンスの容易さを保証します。

IntelliJ IDEA は、変更セットを生成する際にテンプレートを適用する機能を提供します。 この機能により、さまざまなカスタマイズ可能な要素を組み込むことができます。

1. 暗黙的なロールバックをサポートしていない変更セットに空のロールバックを追加する – このオプションは、 暗黙的なロールバックが不足している(英語)新しい変更セットに、TODO コメントを含む空のロールバックタグを自動的に追加します。

2. failOnError および runOnChange: IntelliJ IDEA は changeSet タグ内でよく使用される属性をサポートしており、ユーザーは failOnError および runOnChange のデフォルト値を設定できます。

3. 前提条件を作成する – 各変更セットには特定の前提条件を含めることができます。 例: tableExists および columnExists 前提条件タグが addColumn ステートメントに追加されます。

特定の Liquibase 変更セットではこのオプションが提供されない場合があることに注意することが重要です。 例: タグ procedureExists は createProcedure ステートメントでは使用できません。

以下は、ドロップテーブルチェンジセットに対して有効になっている 4 つの機能すべてを示す例です。

チェンジログとチェンジセットのステータス

どのチェンジログがすでに適用されたかを確認したい場合は、通常、Liquibase の 変更トラッキングコマンドを実行するか、データベース上の チェンジログテーブルを確認する必要があります。 IntelliJ IDEA では、変更のステータスを直接 IDE 上に表示することで、より迅速な確認方法を提供します。

チェンジログファイル全体のステータスは プロジェクト ツールウィンドウ（Alt+1 ）に表示されます。

各チェンジログは Liquibase ロゴ（ ）で表されており、そのステータスはロゴ右下の小さなアイコンで反映されます：

アイコン	状況
	そのチェンジログ内のすべてのチェンジセットがデータベースに正常に適用されました。
	チェンジログは実行されましたが、いずれかのチェンジセットが失敗しました。 ファイル名にマウスを合わせると、エラーの詳細が確認できます。 どのチェンジセットでエラーが発生したか確認するには、アンダーラインが付いたチェンジログをエディターで開き、ガター内の赤い感嘆符を探してください。
(None)	以下の場合、ステータスアイコンは表示されません： チェンジログはまだ実行されていません。 チェンジログは以前に実行されましたが、いずれかのチェンジセットが失敗しました。

特定のチェンジセットのステータスは、チェンジログファイルを開いた際にエディターガター内に表示されます。

JPA デザイナー

JPA デザイナー ツールウィンドウを使用すると、コードを生成および変更できます。

ツールウィンドウの上部 (JPA パレット) で、アクション (例: 作成) を選択し、要素 (例: テーブル) をダブルクリックします。

ツールウィンドウの下部 (JPA インスペクター) は、変更ログの選択された要素 (たとえば、changeSet) に適応し、その属性を変更できるようにします。

JPA デザイナーの詳細については、 エンティティデザイナー を参照してください。

エディターツールバー

エディターツールバーを使用すると、関連するアクションにすばやくアクセスできます。 次のものが含まれます。

1. JPA 構造で開いているファイルを選択するアクション

2. JPA パレットからのすべてのアクション

3. スキーマ変更ログの初期化アクション

4. 差分変更ログアクション

JPA Buddy はデータモデルを理解し、可能な限り変更セットを事前に入力します。 また、JPA Inspector を使用すると、各変更ログ要素の属性を調べることができます。