About

ドキュメント

プロジェクト文書

Built by Maven

概要

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

@Config(config = AppConfig.class)
public interface EmployeeDao {
    @Update
    int update(Employee employee);
    ...
}

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

SQLの自動生成による更新

戻り値の型はintでなければいけません。 戻り値は更新件数を返します。 パラメータは型はエンティティティクラスでなければいけません。 指定できるパラメータの数は1つです。

@Update
int update(Employee employee);

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

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

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

@Update(includeVersion = true)
int update(Employee employee);

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

@Update(suppressOptimisticLockException = true)
int update(Employee employee);

更新対象プロパティ

@Columnupdatable要素

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

@Updateexclude要素

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

@Update(exclude = {"name", "salary"})
int update(Employee employee);

@Updateinclude要素

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

@Update(include = {"name", "salary"})
int update(Employee employee);

@UpdateexcludeNull要素

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

@Update(excludeNull = true)
int update(Employee employee);

@UpdateincludeUnchanged要素

上記の条件に加え、 エンティティティクラス@OriginalStatesが注釈されたプロパティがあり、 @UpdateincludeUnchanged要素がtrueの場合、 エンティティ取得時から変更された値のみが更新対象となります。 エンティティティクラスに@OriginalStatesが注釈されたプロパティがなかったり、 @UpdateincludeUnchanged要素がfalseの場合、 変更されていない値についても更新対象になります。

@Update(includeUnchanged = true)
int update(Employee employee);

SQLファイルによる更新

SQLファイルによる更新を行うには、@UpdatesqlFile要素に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ファイルによる更新では、バージョン番号の自動更新は行われません。 また、@Updateexclude要素、include要素、 excludeNull要素、includeUnchanged要素、includeVersion要素、 suppressOptimisticLockException要素は参照されません。

一意制約違反

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

クエリタイムアウト

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

@Update(queryTimeout = 10)
int update(Employee employee);

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