概要
更新を行うには、@UpdateをDaoのメソッドに注釈します。
@Config(config = AppConfig.class)
public interface EmployeeDao {
@Update
int update(Employee employee);
...
}
デフォルトでは、UPDATE文が自動生成されます。
@UpdateのsqlFileにtrueを設定することで、任意のSQLファイルにマッピングできます。
パラメータのエンティティクラスにエンティティリスナーが指定されている場合、更新の実行前にエンティティリスナーのpreUpdateメソッドを呼び出します。
また、更新の実行後にエンティティリスナーのpostUpdateメソッドを呼び出します。
SQLの自動生成による更新
戻り値の型はintでなければいけません。
戻り値は更新件数を返します。
パラメータの型はエンティティクラスでなければいけません。
指定できるパラメータの数は1つです。
引数はnullであってはいけません。
@Update int update(Employee employee);
SQL自動生成におけるバージョン番号と楽観的排他制御
次の条件を満たす場合に、楽観的排他制御が行われます。
- パラメータのエンティティクラスに
@Versionが注釈されたプロパティがある - @Updateの
ignoreVersion要素がfalseである
楽観的排他制御が有効であれば、バージョン番号は識別子とともに更新条件に含まれ、1増分して更新されます。
このときの更新件数が0件の場合、楽観的排他制御の失敗を示すorg.seasar.doma.jdbc.OptimisticLockExceptionがスローされます。
また、更新件数が0件でない場合、OptimisticLockExceptionはスローされず、エンティティのバージョンプロパティの値が1増分されます。
@UpdateのignoreVersion要素がtrueの場合、
バージョン番号は更新条件には含まれず、UPDATE文のSET句に含まれます。バージョン番号はアプリケーションで設定した値で更新されます。
この場合、更新件数が0件であっても、OptimisticLockExceptionはスローされません。
@Update(ignoreVersion = true) int update(Employee employee);
@UpdateのsuppressOptimisticLockException要素がtrueの場合、
@Versionが注釈されたプロパティがあればバージョン番号は更新条件に含まれ増分もされますが、
更新件数が0件であってもOptimisticLockExceptionはスローされません。
ただし、エンティティのバージョンプロパティの値は1増分されます。
@Update(suppressOptimisticLockException = true) int update(Employee employee);
更新対象プロパティ
@Columnのupdatable要素
エンティティクラスに@Columnが注釈されたプロパティがある場合、
@Columnのupdatable要素がfalseのものは更新対象外です。
@Updateのexclude要素
@Updateのexclude要素に指定されたプロパティを更新対象外とします。
プロパティがこの要素に指定されていれば、@Columnのupdatable要素がtrueであっても更新対象外です。
@Update(exclude = {"name", "salary"})
int update(Employee employee);
@Updateのinclude要素
@Updateのinclude要素に指定されたプロパティのみを削除対象とします。
@Updateのinclude要素とexclude要素の両方に
同じプロパティが指定された場合、そのプロパティは更新対象外になります。
プロパティがこの要素に指定されていても、@Columnのupdatable要素がfalseであれば更新対象外です。
@Update(include = {"name", "salary"})
int update(Employee employee);
@UpdateのexcludeNull要素
@UpdateのexcludeNull要素がtrueの場合、
値がnullのプロパティを削除対象外とします。
この要素がtrueの場合、@Columnのupdatable要素がtrueであったり、
@Updateのinclude要素にプロパティが指定されていても、値がnullであれば更新対象外です。
@Update(excludeNull = true) int update(Employee employee);
@UpdateのincludeUnchanged要素
この要素は、更新対象のエンティティクラスに@OriginalStatesが注釈されたプロパティがある場合にのみ有効です。
この要素がtrueの場合、エンティティの全プロパティが更新対象となります。
つまり、全プロパティに対応するカラムがUPDATE文のSET句に含まれます。
この要素がfalseの場合、エンティティが取得されてから実際に変更されたプロパティのみが更新対象になります。
つまり、変更されたプロパティに対応するカラムのみがUPDATE文のSET句に含まれます。
@Update(includeUnchanged = true) int update(Employee employee);
SQLファイルによる更新
SQLファイルによる更新を行うには、@UpdateのsqlFile要素にtrueを設定し、
メソッドに対応するSQLファイルを用意します。
戻り値の型はintでなければいけません。
戻り値は更新件数を返します。
パラメータには任意の型が使用できます。
指定できるパラメータの数に制限はありません。
パラメータの型が基本型もしくはドメインクラスの場合、引数をnullにできます。
それ以外の型の場合、引数はnullであってはいけません。
@Update(sqlFile = true) int update(Employee employee);
たとえば、上記のメソッドに対応するSQLは次のように記述します。
update employee set name = /* employee.name */'hoge', salary = /* employee.salary */100 where id = /* employee.id */0
SQLファイルによる更新では、@Updateのexclude要素、include要素、
excludeNull要素、includeUnchanged要素は参照されません。
SQLファイルにおけるバージョン番号と楽観的排他制御
次の条件を満たす場合に、楽観的排他制御が行われます。
- パラメータにエンティティクラスを含む
- パラメータの内、左から数えて最初に登場するエンティティクラスに
@Versionが注釈されたプロパティがある - @Updateの
ignoreVersion要素がfalseである
ただし、SQLファイルに楽観的排他制御用のSQLを記述するのは、アプリケーション開発者の責任です。 たとえば、下記のSQLのように、WHERE句でバージョンを番号を指定しSET句でバージョン番号を1だけ増分しなければいけません。
update EMPLOYEE set DELETE_FLAG = 1, VERSION = /* employee.version */1 + 1 where ID = /* employee.id */1 and VERSION = /* employee.version */1
このSQLの更新件数が0件の場合、楽観的排他制御の失敗を示すorg.seasar.doma.jdbc.OptimisticLockExceptionがスローされます。
更新件数が0件でない場合、OptimisticLockExceptionはスローされず、エンティティのバージョンプロパティの値が1増分されます。
@UpdateのignoreVersion要素がtrueの場合、
更新件数が0件であっても、OptimisticLockExceptionはスローされません。
また、エンティティのバージョンプロパティの値は変更されません。
@Update(sqlFile = true, ignoreVersion = true) int update(Employee employee);
@UpdateのsuppressOptimisticLockException要素がtrueの場合、
更新件数が0件であっても、OptimisticLockExceptionはスローされません。
ただし、エンティティのバージョンプロパティの値は1増分されます。
@Update(sqlFile = true, suppressOptimisticLockException = true) int update(Employee employee);
一意制約違反
一意制約違反が発生した場合は、SQLファイルの使用の有無に関係なくorg.seasar.doma.jdbc.UniqueConstraintExceptionがスローされます。
クエリタイムアウト
@UpdateのqueryTimeout要素にクエリタイムアウトの秒数を指定できます。
@Update(queryTimeout = 10) int update(Employee employee);
この設定は、SQLファイルの使用の有無に関係なく適用されます。
queryTimeout要素に値を指定しない場合、
設定クラスに指定されたクエリタイムアウトが使用されます。