概要
バッチ削除を行うには、@BatchDelete
をDaoのメソッドに注釈します。
@Config(config = AppConfig.class) public interface EmployeeDao { @BatchDelete int[] delete(List<Employee> employees); ... }
戻り値の型はint[]
でなければいけません。
パラメータは型はエンティティティクラスを要素とするjava.util.List
でなければいけません。
指定できるパラメータの数は1つです。
戻り値の配列の要素の数はパラメータのList
の要素の数と等しくなります。
配列のそれぞれの要素が更新された件数を返します。
デフォルトでは、DELETE文が自動生成されます。
@BatchDelete
のsqlFile
にtrue
を設定することで、任意のSQLファイルにマッピングできます。
SQLの自動生成によるバッチ削除
バージョン番号と楽観的排他制御
エンティティティクラスに@Version
が注釈されたプロパティがある場合、
@BatchDelete
のignoreVersion
要素がfalse
であれば、
バージョン番号は識別子とともに削除条件に含まれます。
この場合、削除件数が0件であれば、楽観的排他制御の失敗を示すorg.seasar.doma.jdbc.OptimisticLockException
がスローされます。
しかし、@BatchDelete
のignoreVersion
要素がtrue
の場合、
バージョン番号は削除条件には含まれません。
この場合、削除件数が0件であっても、OptimisticLockException
はスローされません。
@BatchDelete(includeVersion = true) int[] delete(List<Employee> employees);
@BatchDelete
のsuppressOptimisticLockException
要素がtrue
の場合、
@Version
が注釈されたプロパティがあればバージョン番号は削除条件に含まれますが、
削除件数が0件であってもOptimisticLockException
のスローは抑制されます。
@BatchDelete(suppressOptimisticLockException = true) int[] delete(List<Employee> employees);
SQLファイルによるバッチ削除
SQLファイルによるバッチ削除を行うには、@BatchDelete
のsqlFile
要素にtrue
を設定し、
メソッドに対応するSQLファイルを用意します。
@BatchDelete(sqlFile = true) int[] delete(List<Employee> employees);
たとえば、上記のメソッドに対応するSQLは次のように記述します。
delete from employee where name = /* employees.name */'hoge'
SQLファイルによるバッチ削除では、、@BatchDelete
のignoreVersion
要素、
suppressOptimisticLockException
要素は参照されません。
クエリタイムアウト
@BatchDelete
のqueryTimeout
要素にクエリタイムアウトの秒数を指定できます。
@BatchDelete(queryTimeout = 10) int[] delete(List<Employee> employees);
この設定は、SQLファイルの使用の有無に関係なく適用されます。
queryTimeout
要素に値を指定しない場合、
設定クラスに指定されたクエリタイムアウトが使用されます。