org.seasar.doma
注釈型 BatchDelete

@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface BatchDelete

バッチ削除処理を示します。

このアノテーションが注釈されるメソッドは、 Daoインタフェースのメンバでなければいけません。

注釈されるメソッドは次の制約を満たす必要があります。

• パラメータを1つだけ受け取る。
• パラメータの型はエンティティクラスを要素とする Iterable のサブタイプである。
• 戻り値の型は int[] である。

例:

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

注釈されるメソッドは、次の例外をスローすることがあります。

• DomaNullPointerException パラメータに null を渡した場合
• OptimisticLockException 楽観的排他制御が有効なで更新件数が0件の場合
• SqlFileNotFoundException sqlFile 要素の値が true で、SQLファイルが見つからなかった場合
• JdbcException 上記以外でJDBCに関する例外が発生した場合

作成者:

taedium

任意要素の概要

int	batchSize バッチサイズです。
boolean	ignoreVersion 楽観的排他制御用のバージョン番号を無視するかどうかを示します。
int	queryTimeout クエリタイムアウト（秒）です。
boolean	sqlFile SQLファイルにマッピングするかどうかを示します。
boolean	suppressOptimisticLockException 削除結果が1件でない場合にスローされる OptimisticLockExceptionを抑制するかどうかを示します。

sqlFile

public abstract boolean sqlFile

SQLファイルにマッピングするかどうかを示します。

デフォルト:

false

queryTimeout

public abstract int queryTimeout

クエリタイムアウト（秒）です。

指定しない場合、Config.getQueryTimeout()が使用されます。

関連項目:

Statement.setQueryTimeout(int)

デフォルト:

-1

batchSize

public abstract int batchSize

バッチサイズです。

指定しない場合、Config.getBatchSize()が使用されます。

Statement.executeBatch() を実行する際のバッチサイズです。 バッチ対象の数がバッチサイズを上回る場合、バッチサイズの数だけ PreparedStatement.addBatch() を呼び出し、 Statement.executeBatch() を実行するということを繰り返します。

導入されたバージョン:

1.21.0

関連項目:

PreparedStatement.addBatch()

デフォルト:

-1

ignoreVersion

public abstract boolean ignoreVersion

楽観的排他制御用のバージョン番号を無視するかどうかを示します。

true の場合、削除条件にバージョン番号を含めません。

デフォルト:

false

suppressOptimisticLockException

public abstract boolean suppressOptimisticLockException

削除結果が1件でない場合にスローされる OptimisticLockExceptionを抑制するかどうかを示します。

この要素に対する指定は、sqlFile() が false の場合にのみ有効です。

デフォルト:

false