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