Hibernate hbm2ddl.auto 設定 - コード例
2024-08-22
hbm2ddl.auto は、Hibernate がデータベース スキーマを自動生成するかどうか、および生成方法を制御する設定です。 主な設定値とその動作は以下の通りです。
- none (デフォルト) : この値を設定すると、Hibernate はデータベース スキーマの自動生成を行いません。 スキーマはあらかじめデータベース上に存在している必要があります。
- create : この値を設定すると、Hibernate は起動時に、Java のエンティティクラス (モデル) に基づいてデータベース スキーマを新規に生成します。 開発環境など、初期状態のスキーマが必要な場合に便利です。
- update : この値を設定すると、Hibernate は起動時に、既存のデータベース スキーマを Java のエンティティクラスに合わせて更新しようとします。 ただし、本番環境では絶対に使用しないでください。 意図しない変更が起きる可能性があります。
- validate : この値を設定すると、Hibernate は起動時に、既存のデータベース スキーマが Java のエンティティクラスと整合しているかどうかを検証します。 スキーマの変更が必要かどうかを確認したい場合に便利です。
- create-drop : この値を設定すると、Hibernate は起動時にデータベース スキーマを新規生成 (create) し、アプリケーション終了時にそのスキーマを削除 (drop) します。 開発環境で頻繁にスキーマを変更する場合に便利ですが、本番環境では使わないでください。
注意:
- create や create-drop を使用すると、既存のデータが失われる可能性があります。 開発環境以外では慎重に使用してください。
- update は、スキーマ変更が複雑になったり、本番環境で予期せぬ動作を引き起こす可能性があるため、本番環境では使用しないでください。 スキーマの変更は、手動で SQL を実行して行うのが一般的です。
Hibernate hbm2ddl.auto 設定 - コード例
設定方法 1: persistence.xml を用いる場合
<?xml version="1.0" encoding="UTF-8"?>
<persistence xmlns="http://xmlns.jcp.org/persistence/1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/persistence/1.0
http://xmlns.jcp.org/xml/ns/persistence/persistence_1.0.xsd">
<persistence-unit name="yourPersistenceUnitName">
<properties>
<property name="hibernate.hbm2ddl.auto" value="create" /> </properties>
</persistence-unit>
</persistence>
設定方法 2: application.properties を用いる場合 (Spring Boot など)
spring.jpa.hibernate.ddl-auto=create ```
**解説:**
* 上記のコード例では、`hbm2ddl.auto` の設定値を `"create"` にしています。 起動時にデータベース スキーマがなければ、エンティティクラスに基づいて新規に生成されます。
* 設定値を変更することで、他の動作 (update, validate など) を指定できます。
**補足:**
* 上記のコードはあくまで設定方法の一例です。使用するフレームワークやライブラリによって、設定方法は異なる場合があります。
* 開発環境でのみ `create` や `create-drop` を使用し、本番環境では必ずあらかじめデータベース スキーマを作成してください。
スクリプトによる手動生成
- 開発環境とは別に本番環境用のスキーマを存在させ、本番環境では hbm2ddl.auto を設定しないのが一般的です。
- スキーマ変更が必要な場合は、SQL スクリプトを直接実行してデータベースを更新します。
- スクリプトによる管理は柔軟性がありますが、変更内容の履歴管理や複数開発者での連携に注意が必要です。
Liquibase や FlywayDB などによるマイグレーションツール
- Liquibase や FlywayDB は、バージョン管理された一連の SQL スクリプトを使ってデータベース スキーマを管理するツールです。
- スクリプトの履歴を管理し、あるバージョンへのロールバックなども可能になります。
- 開発環境と本番環境で同じスクリプトを使用でき、開発チームでの連携がスムーズになります。
エンティティアノテーション
- Hibernate にはテーブルやカラムのマッピングをエンティティクラスに直接アノテーションで記述する方法もあります。
- スキーマ定義をコード内に含めるため、モデル変更とスキーマ変更が密結合になります。
- コードが冗長になりがちで、複雑なスキーマには向いていません。
java hibernate hbm2ddl
