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