org.seasar.doma
注釈型 Insert

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

挿入処理を示します。

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

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

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

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

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

例:

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

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

• DomaNullPointerException パラメータに nullを渡した場合
• UniqueConstraintException 一意制約違反が発生した場合
• SqlFileNotFoundException sqlFile 要素が true で、SQLファイルが見つからなかった場合
• JdbcException 上記以外でJDBCに関する例外が発生した場合

作成者:

taedium

任意要素の概要

String[]	exclude INSERT文から除去するプロパティ名の配列です。
boolean	excludeNull INSERT文で null のプロパティに対応するカラムを除去するかどうかを示します。
String[]	include INSERT文に含めるプロパティ名の配列です。
int	queryTimeout クエリタイムアウト（秒）です。
boolean	sqlFile SQLファイルにマッピングするかどうかを示します。

sqlFile

public abstract boolean sqlFile

SQLファイルにマッピングするかどうかを示します。

デフォルト:

false

queryTimeout

public abstract int queryTimeout

クエリタイムアウト（秒）です。

指定しない場合、Config.getQueryTimeout()が使用されます。

関連項目:

Statement.setQueryTimeout(int)

デフォルト:

-1

excludeNull

public abstract boolean excludeNull

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

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

デフォルト:

false

include

public abstract String[] include

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

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

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

デフォルト:

{}

exclude

public abstract String[] exclude

INSERT文から除去するプロパティ名の配列です。

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

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

デフォルト:

{}