org.seasar.doma
注釈型 Update

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

更新処理を示します。

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

sqlFile() が false の場合、注釈されるメソッドは次の制約を満たす必要があります。

• パラメータを1つだけ受け取る。
• パラメータの型はエンティティクラスである。
• 戻り値の型は int である。

sqlFile() が true の場合、注釈されるメソッドは次の制約を満たす必要があります。

• 戻り値の型は int である。

例:

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

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

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

作成者:

taedium

任意要素の概要

String[]	exclude UPDATE文のSET句から除外するプロパティ名の配列です。
boolean	excludeNull UPDATE文のSET句に null のプロパティに対応するカラムを除去するかどうかを示します。
boolean	ignoreVersion 楽観的排他制御用のバージョン番号を無視するかどうかを示します。
String[]	include UPDATE文のSET句に含めるプロパティ名の配列です。
boolean	includeUnchanged UPDATE文のSET句に変更されていないプロパティに対応するカラムを含めるかどうかを示します。
boolean	includeVersion 推奨されていません。 代わりに 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

excludeNull

public abstract boolean excludeNull

UPDATE文のSET句に null のプロパティに対応するカラムを除去するかどうかを示します。

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

デフォルト:

false

includeVersion

@Deprecated
public abstract boolean includeVersion

推奨されていません。 代わりに ignoreVersion() を使用してください。

UPDATE文のSET句にバージョンプロパティに対応するカラムを含めるかどうかを示します。

デフォルト:

false

ignoreVersion

public abstract boolean ignoreVersion

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

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

導入されたバージョン:

1.7.0

デフォルト:

false

includeUnchanged

public abstract boolean includeUnchanged

UPDATE文のSET句に変更されていないプロパティに対応するカラムを含めるかどうかを示します。

この要素に対する指定は、更新対象のエンティティが OriginalStates が注釈されたプロパティをもつ場合、かつ sqlFile() が false の場合にのみ有効です。

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

デフォルト:

false

include

public abstract String[] include

UPDATE文のSET句に含めるプロパティ名の配列です。

ここに指定できるのは、カラム名ではなく更新対象エンティティクラスのプロパティ名です。

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

デフォルト:

{}

exclude

public abstract String[] exclude

UPDATE文のSET句から除外するプロパティ名の配列です。

ここに指定できるのは、カラム名ではなく更新対象エンティティクラスのプロパティ名です。

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

デフォルト:

{}

suppressOptimisticLockException

public abstract boolean suppressOptimisticLockException

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

デフォルト:

false