概要
バッチ削除を行うには、@BatchDeleteをDaoのメソッドに注釈します。
@Config(config = AppConfig.class)
public interface EmployeeDao {
@BatchDelete
int[] delete(List<Employee> employees);
...
}
デフォルトでは、DELETE文が自動生成されます。
@BatchDeleteのsqlFileにtrueを設定することで、任意のSQLファイルにマッピングできます。
パラメータの要素であるエンティティクラスにエンティティリスナーが指定されている場合、削除の実行前にエンティティリスナーのpreDeleteメソッドをエンティティごとに呼び出します。
また、削除の実行後にエンティティリスナーのpostDeleteメソッドをエンティティごとに呼び出します。
SQLの自動生成によるバッチ削除
戻り値の型はint[]でなければいけません。
パラメータの型はエンティティクラスを要素とするjava.lang.Iterableのサブタイプでなければいけません。
指定できるパラメータの数は1つです。
引数はnullであってはいけません。
戻り値の配列の要素の数はパラメータのIterableの要素の数と等しくなります。
配列のそれぞれの要素が更新された件数を返します。
SQL自動生成におけるバージョン番号と楽観的排他制御
次の条件を満たす場合に、楽観的排他制御が行われます。
- パラメータの
java.lang.Iterableのサブタイプの要素であるエンティティクラスに@Versionが注釈されたプロパティがある - @BatchDeleteの
ignoreVersion要素がfalseである
楽観的排他制御が有効であれば、バージョン番号は識別子とともに削除条件に含まれます。
この場合、削除件数が0件であれば、楽観的排他制御の失敗を示すorg.seasar.doma.jdbc.BatchOptimisticLockExceptionがスローされます。
@BatchDeleteのignoreVersion要素がtrueの場合、
バージョン番号は削除条件には含まれますが、
削除件数が0件であってもBatchOptimisticLockExceptionはスローされません。
@BatchDelete(ignoreVersion = true) int[] delete(List<Employee> employees);
@BatchDeleteのsuppressOptimisticLockException要素がtrueの場合、
@Versionが注釈されたプロパティがあればバージョン番号は削除条件に含まれません。
この場合、削除件数が0件であってもBatchOptimisticLockExceptionのスローされません。
@BatchDelete(suppressOptimisticLockException = true) int[] delete(List<Employee> employees);
SQLファイルによるバッチ削除
SQLファイルによるバッチ削除を行うには、@BatchDeleteのsqlFile要素にtrueを設定し、
メソッドに対応するSQLファイルを用意します。
@BatchDelete(sqlFile = true) int[] delete(List<Employee> employees);
戻り値の型はint[]でなければいけません。
パラメータは任意の型を要素とするjava.lang.Iterableのサブタイプでなければいけません。
指定できるパラメータの数は1つです。
引数はnullであってはいけません。
戻り値の配列の要素の数はパラメータのIterableの要素の数と等しくなります。
配列のそれぞれの要素が更新された件数を返します。
たとえば、上記のメソッドに対応するSQLは次のように記述します。
delete from employee where name = /* employees.name */'hoge'
SQLファイル上では、パラメータの名前はjava.lang.Iterableのサブタイプの要素を指します。
SQLファイルにおけるバージョン番号と楽観的排他制御
次の条件を満たす場合に、楽観的排他制御が行われます。
- パラメータの
java.lang.Iterableのサブタイプの要素がエンティティクラスであり、エンティティクラスに@Versionが注釈されたプロパティがある - @BatchDeleteの
ignoreVersion要素がfalseである - @BatchDeleteの
suppressOptimisticLockException要素がfalseである
ただし、SQLファイルに楽観的排他制御用のSQLを記述するのは、アプリケーション開発者の責任です。 たとえば、下記のSQLのように、WHERE句でバージョンを番号を指定しなければいけません。
delete from EMPLOYEE where ID = /* employees.id */1 and VERSION = /* employees.version */1
このSQLの削除件数が0件の場合、楽観的排他制御の失敗を示すorg.seasar.doma.jdbc.BatchOptimisticLockExceptionがスローされます。
削除件数が0件でない場合、BatchOptimisticLockExceptionはスローされません。
@BatchDeleteのignoreVersion要素、またはsuppressOptimisticLockException要素がtrueの場合、
削除件数が0件であってもBatchOptimisticLockExceptionはスローされません。
@BatchDelete(sqlFile = true, ignoreVersion = true) int[] delete(List<Employee> employees);
@BatchDelete(sqlFile = true, suppressOptimisticLockException = true) int[] delete(List<Employee> employees);
クエリタイムアウト
@BatchDeleteのqueryTimeout要素にクエリタイムアウトの秒数を指定できます。
@BatchDelete(queryTimeout = 10) int[] delete(List<Employee> employees);
この設定は、SQLファイルの使用の有無に関係なく適用されます。
queryTimeout要素に値を指定しない場合、
設定クラスに指定されたクエリタイムアウトが使用されます。
バッチサイズ
@BatchDeleteのbatchSize要素にバッチサイズを指定できます。
@BatchDelete(batchSize = 10) int[] delete(List<Employee> employees);
この設定は、SQLファイルの使用の有無に関係なく適用されます。
batchSize要素に値を指定しない場合、
設定クラスに指定されたバッチサイズが使用されます。