About

ドキュメント

プロジェクト文書

Built by Maven

概要

バッチ更新を行うには、@BatchUpdateをDaoのメソッドに注釈します。

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

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

SQLの自動生成によるバッチ更新

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

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

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

しかし、@BatchUpdateincludeVersion要素がtrueの場合、 バージョン番号は更新条件には含まれず、UPDATE文のSET句に含まれます。バージョン番号はアプリケーションで設定された値で更新されます。 この場合、更新件数が0件であっても、OptimisticLockExceptionはスローされません。

@BatchUpdate(includeVersion = true)
int[] update(List<Employee> employees);

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

@BatchUpdate(suppressOptimisticLockException = true)
int[] update(List<Employee> employees);

更新対象プロパティ

@Columnupdatable要素

エンティティティクラス@Columnが注釈されたプロパティがある場合、 @Columnupdatable要素がfalseのものは更新対象外です。

@BatchUpdateexclude要素

@BatchUpdateexclude要素に指定されたプロパティを更新対象外とします。 プロパティがこの要素に指定されていれば、@Columnupdatable要素がtrueであっても削除対象外です。

@BatchUpdate(exclude = {"name", "salary"})
int[] update(List<Employee> employees);

@BatchUpdateinclude要素

@BatchUpdateinclude要素に指定されたプロパティのみを削除対象とします。 @BatchUpdateinclude要素とexclude要素の両方に 同じプロパティが指定された場合、そのプロパティは更新対象外になります。 プロパティがこの要素に指定されていても、@Columnupdatable要素がfalseであれば更新対象外です。

@BatchUpdate(include = {"name", "salary"})
int[] update(List<Employee> employees);

SQLファイルによるバッチ更新

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

@BatchUpdate(sqlFile = true)
int[] update(List<Employee> employees);

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

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

update employee set name = /* employees.name */'hoge', salary = /* employees.salary */100 where id = /* employees.id */0

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

SQLファイルによるバッチ更新では、バージョン番号の自動更新は行われません。 また、@BatchUpdateexclude要素、include要素、 includeVersion要素、suppressOptimisticLockException要素は参照されません。

一意制約違反

一意制約違反が発生した場合は、SQLファイルの使用の有無に関係なくorg.seasar.doma.jdbc.UniqueConstraintExceptionがスローされます。

クエリタイムアウト

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

@BatchUpdate(queryTimeout = 10)
int[] update(List<Employee> employees);

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