概要
削除を行うには、@Delete
をDaoのメソッドに注釈します。
@Config(config = AppConfig.class) public interface EmployeeDao { @Delete int delete(Employee employee); ... }
デフォルトでは、DELETE文が自動生成されます。
@Delete
のsqlFile
にtrue
を設定することで、任意のSQLファイルにマッピングできます。
SQLの自動生成による削除
戻り値の型はint
でなければいけません。
戻り値は更新件数を返します。
パラメータは型はエンティティティクラスでなければいけません。
指定できるパラメータの数は1つです。
@Delete int delete(Employee employee);
バージョン番号と楽観的排他制御
エンティティティクラスに@Version
が注釈されたプロパティがある場合、
@Delete
のignoreVersion
要素がfalse
であれば、
バージョン番号は識別子とともに削除条件に含まれます。
この場合、削除件数が0件であれば、楽観的排他制御の失敗を示すorg.seasar.doma.jdbc.OptimisticLockException
がスローされます。
しかし、@Delete
のignoreVersion
要素がtrue
の場合、
バージョン番号は削除条件には含まれません。
この場合、削除件数が0件であっても、OptimisticLockException
はスローされません。
@Delete(includeVersion = true) int delete(Employee employee);
@Delete
のsuppressOptimisticLockException
要素がtrue
の場合、
@Version
が注釈されたプロパティがあればバージョン番号は削除条件に含まれますが、
削除件数が0件であってもOptimisticLockException
のスローは抑制されます。
@Delete(suppressOptimisticLockException = true) int delete(Employee employee);
SQLファイルによる削除
SQLファイルによる削除を行うには、@Delete
のsqlFile
要素にtrue
を設定し、
メソッドに対応するSQLファイルを用意します。
戻り値の型はint
でなければいけません。
戻り値は更新件数を返します。
パラメータには任意の型が使用できます。
指定できるパラメータの数に制限はありません。
@Delete(sqlFile = true) int delete(Employee employee);
たとえば、上記のメソッドに対応するSQLは次のように記述します。
delete from employee where name = /* employee.name */'hoge'
SQLファイルによる削除では、、@Delete
のignoreVersion
要素、
suppressOptimisticLockException
要素は参照されません。
クエリタイムアウト
@Delete
のqueryTimeout
要素にクエリタイムアウトの秒数を指定できます。
@Delete(queryTimeout = 10) int delete(Employee employee);
この設定は、SQLファイルの使用の有無に関係なく適用されます。
queryTimeout
要素に値を指定しない場合、
設定クラスに指定されたクエリタイムアウトが使用されます。