削除を行うには、@DeleteをDaoのメソッドに注釈します。
デフォルトでは、DELETE文が自動生成されます。
@DeleteのsqlFileにtrueを設定することで、任意のSQLファイルにマッピングできます。
パラメータのエンティティクラスにエンティティリスナーが指定されている場合、削除の実行前にエンティティリスナーのpreDeleteメソッドを呼び出します。
また、削除の実行後にエンティティリスナーのpostDeleteメソッドを呼び出します。
戻り値の型はintでなければいけません。
戻り値は更新件数を返します。
パラメータの型はエンティティクラスでなければいけません。
指定できるパラメータの数は1つです。
引数はnullであってはいけません。
次の条件を満たす場合に、楽観的排他制御が行われます。
@Versionが注釈されたプロパティがあるignoreVersion要素がfalseである
楽観的排他制御が有効であれば、バージョン番号は識別子とともに削除条件に含まれます。
この場合、削除件数が0件であれば、楽観的排他制御の失敗を示すorg.seasar.doma.jdbc.OptimisticLockExceptionがスローされます。
@DeleteのignoreVersion要素がtrueの場合、
バージョン番号は削除条件に含まれません。
この場合、削除件数が0件であっても、OptimisticLockExceptionはスローされません。
@DeleteのsuppressOptimisticLockException要素がtrueの場合、
バージョン番号は削除条件に含まれます。
しかし、この場合、削除件数が0件であっても、OptimisticLockExceptionはスローされません。
SQLファイルによる削除を行うには、@DeleteのsqlFile要素にtrueを設定し、
メソッドに対応するSQLファイルを用意します。
戻り値の型はintでなければいけません。
戻り値は更新件数を返します。
パラメータには任意の型が使用できます。
指定できるパラメータの数に制限はありません。
パラメータの型が基本型もしくはドメインクラスの場合、引数をnullにできます。
それ以外の型の場合、引数はnullであってはいけません。
エンティティにエンティティリスナーが指定されていても、エンティティリスナーのメソッドは呼び出しません。
たとえば、上記のメソッドに対応するSQLは次のように記述します。
次の条件を満たす場合に、楽観的排他制御が行われます。
@Versionが注釈されたプロパティがあるignoreVersion要素がfalseであるsuppressOptimisticLockException要素がfalseであるただし、SQLファイルに楽観的排他制御用のSQLを記述するのは、アプリケーション開発者の責任です。 たとえば、下記のSQLのように、WHERE句でバージョンを番号を指定しなければいけません。
このSQLの削除件数が0件の場合、楽観的排他制御の失敗を示すorg.seasar.doma.jdbc.OptimisticLockExceptionがスローされます。
削除件数が0件でない場合、OptimisticLockExceptionはスローされません。
@DeleteのignoreVersion要素、またはsuppressOptimisticLockException要素がtrueの場合、
削除件数が0件であっても、OptimisticLockExceptionはスローされません。
@DeleteのqueryTimeout要素にクエリタイムアウトの秒数を指定できます。
この設定は、SQLファイルの使用の有無に関係なく適用されます。
queryTimeout要素に値を指定しない場合、
設定クラスに指定されたクエリタイムアウトが使用されます。