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