概要
挿入を行うには、@InsertをDaoのメソッドに注釈します。
@Config(config = AppConfig.class)
public interface EmployeeDao {
@Insert
int insert(Employee employee);
...
}
デフォルトでは、INSERT文が自動生成されます。
@InsertのsqlFileにtrueを設定することで、任意のSQLファイルにマッピングできます。
パラメータのエンティティクラスにエンティティリスナーが指定されている場合、挿入の実行前にエンティティリスナーのpreInsertメソッドを呼び出します。
また、挿入の実行後にエンティティリスナーのpostInsertメソッドを呼び出します。
SQLの自動生成による挿入
戻り値の型はintでなければいけません。
戻り値は更新件数を返します。
パラメータの型はエンティティクラスでなければいけません。
指定できるパラメータの数は1つです。
引数はnullであってはいけません。
@Insert int insert(Employee employee);
識別子
エンティティクラスの識別子に、@GeneratedValueが注釈されている場合、
識別子が自動的に生成され設定されます。
バージョン番号
エンティティクラスに@Versionが注釈されたプロパティがある場合、
そのプロパティに明示的に1以上の値が設定されていればその値を使用します。
もし設定されていないか、0以下の値が設定されていれば1を自動で設定します。
挿入対象プロパティ
@Columnのinsertable要素
エンティティクラスに@Columnが注釈されたプロパティがある場合、
@Columnのinsertable要素がfalseのものは挿入対象外です。
@Insertのexclude要素
@Insertのexclude要素に指定されたプロパティを挿入対象外とします。
プロパティがこの要素に指定されていれば、@Columnのinsertable要素がtrueであっても挿入対象外です。
@Insert(exclude = {"name", "salary"})
int insert(Employee employee);
@Insertのinclude要素
@Insertのinclude要素に指定されたプロパティのみを挿入対象とします。
@Insertのinclude要素とexclude要素の両方に
同じプロパティが指定された場合、そのプロパティは挿入対象外になります。
プロパティがこの要素に指定されていても、@Columnのinsertable要素がfalseであれば挿入対象外です。
@Insert(include = {"name", "salary"})
int insert(Employee employee);
@InsertのexcludeNull要素
@InsertのexcludeNull要素がtrueの場合、
値がnullのプロパティを挿入対象外とします。
この要素がtrueの場合、@Columnのinsertable要素がtrueであったり、
@Insertのinclude要素にプロパティが指定されていても、値がnullであれば挿入対象外です。
@Insert(excludeNull = true) int insert(Employee employee);
SQLファイルによる挿入
SQLファイルによる挿入を行うには、@InsertのsqlFile要素にtrueを設定し、
メソッドに対応するSQLファイルを用意します。
戻り値の型はintでなければいけません。
戻り値は更新件数を返します。
パラメータには任意の型が使用できます。
指定できるパラメータの数に制限はありません。
パラメータの型が基本型もしくはドメインクラスの場合、引数をnullにできます。
それ以外の型の場合、引数はnullであってはいけません。
@Insert(sqlFile = true) int insert(Employee employee);
たとえば、上記のメソッドに対応するSQLは次のように記述します。
insert into employee (id, name, salary, version) values (/*employee.id*/0, /* employee.name */'hoge', /* employee.salary */100, /* employee.version */0)
SQLファイルによる挿入では、識別子の自動設定やバージョン番号の自動設定は行われません。
また、@Insertのexclude要素、include要素、
excludeNull要素は参照されません。
一意制約違反
一意制約違反が発生した場合は、SQLファイルの使用の有無に関係なくorg.seasar.doma.jdbc.UniqueConstraintExceptionがスローされます。
クエリタイムアウト
@InsertのqueryTimeout要素にクエリタイムアウトの秒数を指定できます。
@Insert(queryTimeout = 10) int insert(Employee employee);
この設定は、SQLファイルの使用の有無に関係なく適用されます。
queryTimeout要素に値を指定しない場合、
設定クラスに指定されたクエリタイムアウトが使用されます。