About

ドキュメント

プロジェクト文書

Built by Maven

概要

バッチ削除を行うには、@BatchDeleteをDaoのメソッドに注釈します。

@Config(config = AppConfig.class)
public interface EmployeeDao {
    @BatchDelete
    int[] delete(List<Employee> employees);
    ...
}

デフォルトでは、DELETE文が自動生成されます。 @BatchDeletesqlFiletrueを設定することで、任意のSQLファイルにマッピングできます。

SQLの自動生成によるバッチ削除

戻り値の型はint[]でなければいけません。 パラメータは型はエンティティティクラスを要素とするjava.lang.Iterableのサブタイプでなければいけません。 指定できるパラメータの数は1つです。 戻り値の配列の要素の数はパラメータのIterableの要素の数と等しくなります。 配列のそれぞれの要素が更新された件数を返します。

バージョン番号と楽観的排他制御

エンティティティクラス@Versionが注釈されたプロパティがある場合、 @BatchDeleteignoreVersion要素がfalseであれば、 バージョン番号は識別子とともに削除条件に含まれます。 この場合、削除件数が0件であれば、楽観的排他制御の失敗を示すorg.seasar.doma.jdbc.OptimisticLockExceptionがスローされます。

しかし、@BatchDeleteignoreVersion要素がtrueの場合、 バージョン番号は削除条件には含まれません。 この場合、削除件数が0件であっても、OptimisticLockExceptionはスローされません。

@BatchDelete(includeVersion = true)
int[] delete(List<Employee> employees);

@BatchDeletesuppressOptimisticLockException要素がtrueの場合、 @Versionが注釈されたプロパティがあればバージョン番号は削除条件に含まれますが、 削除件数が0件であってもOptimisticLockExceptionのスローは抑制されます。

@BatchDelete(suppressOptimisticLockException = true)
int[] delete(List<Employee> employees);

SQLファイルによるバッチ削除

SQLファイルによるバッチ削除を行うには、@BatchDeletesqlFile要素にtrueを設定し、 メソッドに対応するSQLファイルを用意します。

@BatchDelete(sqlFile = true)
int[] delete(List<Employee> employees);

戻り値の型はint[]でなければいけません。 パラメータは任意の型を要素とするjava.lang.Iterableのサブタイプでなければいけません。 指定できるパラメータの数は1つです。 戻り値の配列の要素の数はパラメータのIterableの要素の数と等しくなります。 配列のそれぞれの要素が更新された件数を返します。

たとえば、上記のメソッドに対応するSQLは次のように記述します。

delete from employee where name = /* employees.name */'hoge'

SQLファイル上では、パラメータの名前はjava.lang.Iterableのサブタイプの要素を指します。

SQLファイルによるバッチ削除では、@BatchDeleteignoreVersion要素、 suppressOptimisticLockException要素は参照されません。

クエリタイムアウト

@BatchDeletequeryTimeout要素にクエリタイムアウトの秒数を指定できます。

@BatchDelete(queryTimeout = 10)
int[] delete(List<Employee> employees);

この設定は、SQLファイルの使用の有無に関係なく適用されます。 queryTimeout要素に値を指定しない場合、 設定クラスに指定されたクエリタイムアウトが使用されます。