問い合わせ条件¶

問い合わせ条件にはメソッドのパラメータを使用します。 利用できるパラメータの型は以下のものです。

• 基本型
• ドメインクラス
• 任意の型
• 基本型 や ドメインクラス や任意の型を要素とするjava.util.Optional
• 基本型 や ドメインクラス を要素とするjava.util.Iterable
• java.util.OptionalInt
• java.util.OptionalLong
• java.util.OptionalDouble

パラメータの数に制限はありません。 パラメータの型が 基本型 もしくは ドメインクラス の場合、引数を null にできます。 それ以外の型の場合、引数は null であってはいけません。

@Select
List<Employee> selectByNameAndSalary(String name, Salary salary);

select * from employee where employee_name = /* name */'hoge' and salary > /* salary */100

@Select
List<Employee> selectByExample(Employee employee);

select * from employee where employee_name = /* employee.name */'hoge' and salary > /* employee.getSalary() */100

@Select
List<Employee> selectByEmployeeAndDepartment(Employee employee, Department department);

@Select
List<Employee> selectByNames(List<String> names);

select * from employee where employee_name in /* names */('aaa','bbb','ccc')

1件検索¶

1件を検索するには、メソッドの戻り値の型を次のいずれかにします。

• 基本型
• ドメインクラス
• エンティティクラス
• java.util.Map<String, Object>
• 基本型 、 ドメインクラス 、 エンティティクラス 、 java.util.Map<String, Object> のいずれかを要素とするjava.util.Optional
• java.util.OptionalInt
• java.util.OptionalLong
• java.util.OptionalDouble

@Select
Employee selectByNameAndSalary(String name, BigDecimal salary);

戻り値の型が Optional でなく、かつ、結果が0件のときは null が返されます。 検索結果の保証 を有効にした場合は、戻り値の型に関係なく結果が0件ならば例外がスローされます。

結果が2件以上存在するときは、 NonUniqueResultException がスローされます。

複数件検索¶

複数件を検索するには、メソッドの戻り値の型を java.util.List にします。 List の要素の型には次のものが使用できます。

• 基本型
• ドメインクラス
• エンティティクラス
• java.util.Map<String, Object>
• 基本型 もしくは ドメインクラス のいずれかを要素とするjava.util.Optional
• java.util.OptionalInt
• java.util.OptionalLong
• java.util.OptionalDouble

@Select
List<Employee> selectByNameAndSalary(String name, Salary salary);

結果が0件のときは null ではなく空のListが返されます。 ただし、 検索結果の保証 を有効にした場合、結果が0件ならば例外がスローされます。

ストリーム検索¶

全件を一度に java.util.List で受け取るのではなく java.util.stream.Stream で扱いたい場合は、ストリーム検索を利用できます。

ストリーム検索を実施するには、 @Select の strategy 要素に SelectType.STREAM を設定し、 メソッドのパラメータに java.util.Function<Stream<TARGET>, RESULT> もしくは java.util.Function<Stream<TARGET>, RESULT> のサブタイプを定義します。

@Select(strategy = SelectType.STREAM)
BigDecimal selectByNameAndSalary(String name, BigDecimal salary, Function<Stream<Employee>, BigDecimal> mapper);

呼び出し元はストリームを受け取って結果を返すラムダ式を渡します。

EmployeeDao dao = new EmployeeDao();
BigDecimal result = dao.selectByNameAndSalary(name, salary, stream -> {
    return ...;
});

Function<Stream<TARGET>, RESULT> の型パラメータ TARGET は次のいずれかでなければいけません。

• 基本型
• ドメインクラス
• エンティティクラス
• java.util.Map<String, Object>
• 基本型 もしくは ドメインクラス のいずれかを要素とするjava.util.Optional
• java.util.OptionalInt
• java.util.OptionalLong
• java.util.OptionalDouble

型パラメータ RESULT はDaoのメソッドの戻り値に合わせなければいけません。

検索結果の保証 を有効にした場合、結果が0件ならば例外がスローされます。

コレクト検索¶

検索結果を java.util.Collector で処理したい場合は、コレクト検索を利用できます。

コレクト検索を実施するには、 @Select の strategy 要素に SelectType.COLLECT を設定し、 メソッドのパラメータに java.stream.Collector<TARGET, ACCUMULATION, RESULT> もしくは java.stream.Collector<TARGET, ?, RESULT> のサブタイプを定義します。

@Select(strategy = SelectType.COLLECT)
<RESULT> RESULT selectBySalary(BigDecimal salary, Collector<Employee, ?, RESULT> collector);

呼び出し元は Collector のインスタンスを渡します。

EmployeeDao dao = new EmployeeDaoImpl();
Map<Integer, List<Employee>> result =
    dao.selectBySalary(salary, Collectors.groupingBy(Employee::getDepartmentId));

Collector<TARGET, ACCUMULATION, RESULT> の型パラメータ TARGET は次のいずれかでなければいけません。

• 基本型
• ドメインクラス
• エンティティクラス
• java.util.Map<String, Object>
• 基本型 もしくは ドメインクラス のいずれかを要素とするjava.util.Optional
• java.util.OptionalInt
• java.util.OptionalLong
• java.util.OptionalDouble

型パラメータ RESULT はDaoのメソッドの戻り値に合わせなければいけません。

検索結果の保証 を有効にした場合、結果が0件ならば例外がスローされます。

検索オプションを利用した検索¶

検索オプションを表す SelectOptions を使用することで、SELECT文が記述されたSQLファイルをベースにし、 ページング処理や悲観的排他制御用のSQLを自動で生成できます。

SelectOptions は、 1件検索 、 複数件検索 、 ストリーム検索 と組み合わせて使用します。

SelectOptions は、Daoのメソッドのパラメータとして定義します。

@Config(config = AppConfig.class)
public interface EmployeeDao {
    @Select
    List<Employee> selectByDepartmentName(String departmentName, SelectOptions options);
    ...
}

SelectOptions のインスタンスは、staticな get メソッドにより取得できます。

SelectOptions options = SelectOptions.get();

SelectOptions options = SelectOptions.get().offset(5).limit(10);
EmployeeDao dao = new EmployeeDao();
List<Employee> list = dao.selectByDepartmentName("ACCOUNT", options);

SelectOptions options = SelectOptions.get().forUpdate();
EmployeeDao dao = new EmployeeDao();
List<Employee> list = dao.selectByDepartmentName("ACCOUNT", options);

SelectOptions options = SelectOptions.get().offset(5).limit(10).count();
EmployeeDao dao = new EmployeeDao();
List<Employee> list = dao.selectByDepartmentName("ACCOUNT", options);
long count = options.getCount();

検索結果の保証¶

検索結果が1件以上存在することを保証したい場合は、 @Select の ensureResult 要素に true を指定します。

@Select(ensureResult = true)
Employee selectById(Integer id);

検索結果が0件ならば NoResultException がスローされます。

検索結果のマッピングの保証¶

エンティティのプロパティすべてに対して漏れなく結果セットのカラムをマッピングすることを保証したい場合は、 @Select の ensureResultMapping 要素に true を指定します。

@Select(ensureResultMapping = true)
Employee selectById(Integer id);

結果セットのカラムにマッピングされないプロパティが存在する場合 ResultMappingException がスローされます。

クエリタイムアウト¶

@Select の queryTimeout 要素にクエリタイムアウトの秒数を指定できます。

@Select(queryTimeout = 10)
List<Employee> selectAll();

値を指定しない場合、 設定 に指定されたクエリタイムアウトが使用されます。

フェッチサイズ¶

@Select の fetchSize 要素にフェッチサイズを指定できます。

@Select(fetchSize = 20) List<Employee> selectAll();

値を指定しない場合、 設定 に指定されたフェッチサイズが使用されます。

最大行数¶

@Select の maxRows 要素に最大行数を指定できます。

@Select(maxRows = 100)
List<Employee> selectAll();

値を指定しない場合、 設定 に指定された最大行数が使用されます。

マップのキーのネーミング規約¶

検索結果を java.util.Map<String, Object> にマッピングする場合、 @Select の mapKeyNaming 要素にマップのキーのネーミング規約を指定できます。

@Select(mapKeyNaming = MapKeyNamingType.CAMEL_CASE)
List<Map<String, Object>> selectAll();

MapKeyNamingType.CAMEL_CASE は、カラム名をキャメルケースに変換することを示します。 そのほかにカラム名を大文字や小文字に変換する規約があります。

最終的な変換結果は、ここに指定した値と 設定 に指定された MapKeyNaming の実装により決まります。

SQL のログ出力形式¶

@Select の sqlLog 要素に SQL のログ出力形式を指定できます。

@Select(sqlLog = SqlLogType.RAW)
List<Employee> selectById(Integer id);

SqlLogType.RAW はバインドパラメータ（?）付きの SQL をログ出力することを表します。

戻り値¶

パラメータがイミュータブルなエンティティクラスの場合、 戻り値はそのエンティティクラスを要素とする org.seasar.doma.Result でなければいけません。

上記の条件を満たさないない場合、戻り値は更新件数を表す int でなければいけません。

SQLの自動生成による挿入¶

パラメータの型はエンティティクラスでなければいけません。 指定できるパラメータの数は1つです。 引数はnullであってはいけません。

@Insert
int insert(Employee employee);

@Insert
Result<ImmutableEmployee> insert(ImmutableEmployee employee);

@Insert(exclude = {"name", "salary"})
int insert(Employee employee);

@Insert(include = {"name", "salary"})
int insert(Employee employee);

@Insert(excludeNull = true)
int insert(Employee employee);

SQLファイルによる挿入¶

SQLファイルによる挿入を行うには、 @Insert の sqlFile 要素に true を設定し、 メソッドに対応するSQLファイルを用意します。

パラメータには任意の型が使用できます。 指定できるパラメータの数に制限はありません。 パラメータの型が基本型もしくはドメインクラスの場合、引数を null にできます。 それ以外の型の場合、引数は null であってはいけません。

@Insert(sqlFile = true)
int insert(Employee employee);

@Insert(sqlFile = true)
Result<ImmutableEmployee> insert(ImmutableEmployee 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ファイルの使用の有無に関係なく UniqueConstraintException がスローされます。

クエリタイムアウト¶

@Insert の queryTimeout 要素にクエリタイムアウトの秒数を指定できます。

@Insert(queryTimeout = 10)
int insert(Employee employee);

この指定は、SQLファイルの使用の有無に関係なく適用されます。 queryTimeout 要素に値を指定しない場合、 設定 に指定されたクエリタイムアウトが使用されます。

SQL のログ出力形式¶

@Insert の sqlLog 要素に SQL のログ出力形式を指定できます。

@Insert(sqlLog = SqlLogType.RAW)
int insert(Employee employee);

SqlLogType.RAW はバインドパラメータ（?）付きの SQL をログ出力することを表します。

戻り値¶

パラメータがイミュータブルなエンティティクラスの場合、 戻り値はそのエンティティクラスを要素とする org.seasar.doma.Result でなければいけません。

上記の条件を満たさないない場合、戻り値は更新件数を表す int でなければいけません。

SQLの自動生成による更新¶

パラメータの型はエンティティクラスでなければいけません。 指定できるパラメータの数は1つです。 引数は null であってはいけません。

@Update
int update(Employee employee);

@Update
Result<ImmutableEmployee> update(ImmutableEmployee employee);

@Update(ignoreVersion = true)
int update(Employee employee);

@Update(suppressOptimisticLockException = true)
int update(Employee employee);

@Update(exclude = {"name", "salary"})
int update(Employee employee);

@Update(include = {"name", "salary"})
int update(Employee employee);

@Update(excludeNull = true)
int update(Employee employee);

@Update(includeUnchanged = true)
int update(Employee employee);

SQLファイルによる更新¶

SQLファイルによる更新を行うには、 @Update の sqlFile 要素に true を設定し、 メソッドに対応するSQLファイルを用意します。

パラメータには任意の型が使用できます。 指定できるパラメータの数に制限はありません。 パラメータの型が基本型もしくはドメインクラスの場合、引数を null にできます。 それ以外の型の場合、引数は null であってはいけません。

@Update(sqlFile = true)
int update(Employee employee);

@Update(sqlFile = true)
Result<ImmutableEmployee> update(ImmutableEmployee employee);

たとえば、上記のメソッドに対応するSQLは次のように記述します。

update employee set name = /* employee.name */'hoge', salary = /* employee.salary */100
where id = /* employee.id */0

SQLファイルによる更新では、 @Update の exclude 要素、 include 要素、 excludeNull 要素、 includeUnchanged 要素は参照されません。

update EMPLOYEE set DELETE_FLAG = 1, VERSION = /* employee.version */1 + 1
where ID = /* employee.id */1 and VERSION = /* employee.version */1

@Update(sqlFile = true, ignoreVersion = true)
int update(Employee employee);

@Update(sqlFile = true, suppressOptimisticLockException = true)
int update(Employee employee);

一意制約違反¶

一意制約違反が発生した場合は、SQLファイルの使用の有無に関係なく UniqueConstraintException がスローされます。

クエリタイムアウト¶

@Update の queryTimeout 要素にクエリタイムアウトの秒数を指定できます。

@Update(queryTimeout = 10)
int update(Employee employee);

この指定はSQLファイルの使用の有無に関係なく適用されます。 queryTimeout 要素に値を指定しない場合、 設定 に指定されたクエリタイムアウトが使用されます。

SQL のログ出力形式¶

@Update の sqlLog 要素に SQL のログ出力形式を指定できます。

@Update(sqlLog = SqlLogType.RAW)
int update(Employee employee);

SqlLogType.RAW はバインドパラメータ（?）付きの SQL をログ出力することを表します。

戻り値¶

戻り値は更新件数を表す int でなければいけません。

SQLの自動生成による削除¶

パラメータの型はエンティティクラスでなければいけません。 指定できるパラメータの数は1つです。 引数は null であってはいけません。

@Delete
int delete(Employee employee);

@Delete
Result<ImmutableEmployee> delete(ImmutableEmployee employee);

@Delete(includeVersion = true)
int delete(Employee employee);

@Delete(suppressOptimisticLockException = true)
int delete(Employee employee);

SQLファイルによる削除¶

SQLファイルによる削除を行うには、 @Delete の sqlFile 要素に true を設定し、 メソッドに対応するSQLファイルを用意します。

パラメータには任意の型が使用できます。 指定できるパラメータの数に制限はありません。 パラメータの型が基本型もしくはドメインクラスの場合、引数を null にできます。 それ以外の型の場合、引数は null であってはいけません。

エンティティにエンティティリスナーが指定されていても、エンティティリスナーのメソッドは呼び出しません。

@Delete(sqlFile = true)
int delete(Employee employee);

たとえば、上記のメソッドに対応するSQLは次のように記述します。

delete from employee where name = /* employee.name */'hoge'

delete from EMPLOYEE where ID = /* employee.id */1 and VERSION = /* employee.version */1

@Delete(sqlFile = true, includeVersion = true)
int delete(Employee employee);

@Delete(sqlFile = true, suppressOptimisticLockException = true)
int delete(Employee employee);

クエリタイムアウト¶

@Delete の queryTimeout 要素にクエリタイムアウトの秒数を指定できます。

@Delete(queryTimeout = 10)
int delete(Employee employee);

この指定は、SQLファイルの使用の有無に関係なく適用されます。 queryTimeout 要素に値を指定しない場合、 設定 に指定されたクエリタイムアウトが使用されます。

SQL のログ出力形式¶

@Delete の sqlLog 要素に SQL のログ出力形式を指定できます。

@Delete(sqlLog = SqlLogType.RAW)
int delete(Employee employee);

SqlLogType.RAW はバインドパラメータ（?）付きの SQL をログ出力することを表します。

戻り値¶

パラメータ Iterable のサブタイプの要素がイミュータブルなエンティティクラスの場合、 戻り値はそのエンティティクラスを要素とする org.seasar.doma.BatchResult でなければいけません。

上記の条件を満たさないない場合、戻り値は各更新処理の更新件数を表す int[] でなければいけません。

SQLの自動生成によるバッチ挿入¶

パラメータの型は エンティティクラス 要素とする java.lang.Iterable のサブタイプでなければいけません。 指定できるパラメータの数は1つです。 引数は null であってはいけません。 戻り値の配列の要素の数はパラメータの Iterable の要素の数と等しくなります。 配列のそれぞれの要素が更新された件数を返します。

@BatchInsert(exclude = {"name", "salary"})
int[] insert(List<Employee> employees);

@BatchInsert(include = {"name", "salary"})
int[] insert(List<Employee> employees);

SQLファイルによるバッチ挿入¶

SQLファイルによるバッチ挿入を行うには、 @BatchInsert の sqlFile 要素に true を設定し、 メソッドに対応するSQLファイルを用意します。

@BatchInsert(sqlFile = true)
int[] insert(List<Employee> employees);

@BatchInsert(sqlFile = true)
BatchResult<ImmutableEmployee> insert(List<ImmutableEmployee> employees);

パラメータは任意の型を要素とする 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ファイルの使用の有無に関係なく 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 要素に値を指定しない場合、 設定 に指定されたバッチサイズが使用されます。

SQL のログ出力形式¶

@BatchInsert の sqlLog 要素に SQL のログ出力形式を指定できます。

@BatchInsert(sqlLog = SqlLogType.RAW)
int insert(Employee employee);

SqlLogType.RAW はバインドパラメータ（?）付きの SQL をログ出力することを表します。

戻り値¶

パラメータ Iterable のサブタイプの要素がイミュータブルなエンティティクラスの場合、 戻り値はそのエンティティクラスを要素とする org.seasar.doma.BatchResult でなければいけません。

上記の条件を満たさないない場合、戻り値は各更新処理の更新件数を表す int[] でなければいけません。

SQLの自動生成によるバッチ更新¶

パラメータの型は エンティティクラス を要素とする java.lang.Iterable のサブタイプでなければいけません。 指定できるパラメータの数は1つです。 引数は null であってはいけません。 戻り値の配列の要素の数はパラメータの Iterable の要素の数と等しくなります。 配列のそれぞれの要素が更新された件数を返します。

@BatchUpdate(ignoreVersion = true)
int[] update(List<Employee> employees);

@BatchUpdate(suppressOptimisticLockException = true)
int[] update(List<Employee> employees);

@BatchUpdate(exclude = {"name", "salary"})
int[] update(List<Employee> employees);

@BatchUpdate(include = {"name", "salary"})
int[] update(List<Employee> employees);

SQLファイルによるバッチ更新¶

SQLファイルによるバッチ更新を行うには、 @BatchUpdate の sqlFile 要素に true を設定し、 メソッドに対応するSQLファイルを用意します。

@BatchUpdate(sqlFile = true)
int[] update(List<Employee> employees);

@BatchUpdate
BatchResult<ImmutableEmployee> update(List<ImmutableEmployee> employees);

パラメータは任意の型を要素とする java.lang.Iterable のサブタイプでなければいけません。 指定できるパラメータの数は1つです。 引数は null であってはいけません。 戻り値の配列の要素の数はパラメータの Iterable の要素の数と等しくなります。 配列のそれぞれの要素が更新された件数を返します。

たとえば、上記のメソッドに対応するSQLは次のように記述します。

update employee set name = /* employees.name */'hoge', salary = /* employees.salary */100
where id = /* employees.id */0

SQLファイル上では、パラメータの名前は Iterable のサブタイプの要素を指します。

SQLファイルによるバッチ更新では、バージョン番号の自動更新は行われません。 また、 @BatchUpdate の exclude 要素、 include 要素は参照されません。

update EMPLOYEE set DELETE_FLAG = 1, VERSION = /* employees.version */1 + 1
where ID = /* employees.id */1 and VERSION = /* employees.version */1

@BatchUpdate(sqlFile = true, ignoreVersion = true)
int[] update(List<Employee> employees);

@BatchUpdate(sqlFile = true, suppressOptimisticLockException = true)
int[] update(List<Employee> employees);

一意制約違反¶

一意制約違反が発生した場合は、SQLファイルの使用の有無に関係なく UniqueConstraintException がスローされます。

クエリタイムアウト¶

@BatchUpdate の queryTimeout 要素にクエリタイムアウトの秒数を指定できます。

@BatchUpdate(queryTimeout = 10)
int[] update(List<Employee> employees);

この設定は、SQLファイルの使用の有無に関係なく適用されます。 queryTimeout 要素に値を指定しない場合、 設定クラスに指定されたクエリタイムアウトが使用されます。

バッチサイズ¶

@BatchUpdate の batchSize 要素にバッチサイズを指定できます。

@BatchUpdate(batchSize = 10)
int[] update(List<Employee> employees);

この指定は、SQLファイルの使用の有無に関係なく適用されます。 batchSize 要素に値を指定しない場合、 設定 クラスに指定されたバッチサイズが使用されます。

SQL のログ出力形式¶

@BatchUpdate の sqlLog 要素に SQL のログ出力形式を指定できます。

@BatchUpdate(sqlLog = SqlLogType.RAW)
int[] update(List<Employee> employees);

SqlLogType.RAW はバインドパラメータ（?）付きの SQL をログ出力することを表します。

戻り値¶

戻り値は各更新処理の更新件数を表す int[] でなければいけません。

SQLの自動生成によるバッチ削除¶

パラメータの型は エンティティクラス を要素とする java.lang.Iterable のサブタイプでなければいけません。 指定できるパラメータの数は1つです。 引数は null であってはいけません。 戻り値の配列の要素の数はパラメータの Iterable の要素の数と等しくなります。 配列のそれぞれの要素が更新された件数を返します。

@BatchDelete(ignoreVersion = true)
int[] delete(List<Employee> employees);

@BatchDelete(suppressOptimisticLockException = true)
int[] delete(List<Employee> employees);

SQLファイルによるバッチ削除¶

SQLファイルによるバッチ削除を行うには、 @BatchDelete の sqlFile 要素に true を設定し、 メソッドに対応するSQLファイルを用意します。

@BatchDelete(sqlFile = true)
int[] delete(List<Employee> employees);

パラメータは任意の型を要素とする java.lang.Iterable のサブタイプでなければいけません。 指定できるパラメータの数は1つです。 引数は null であってはいけません。 戻り値の配列の要素の数はパラメータの Iterable の要素の数と等しくなります。 配列のそれぞれの要素が更新された件数を返します。

たとえば、上記のメソッドに対応するSQLは次のように記述します。

delete from employee where name = /* employees.name */'hoge'

SQLファイル上では、パラメータの名前は java.lang.Iterable のサブタイプの要素を指します。

delete from EMPLOYEE where ID = /* employees.id */1 and VERSION = /* employees.version */1

@BatchDelete(sqlFile = true, ignoreVersion = true)
int[] delete(List<Employee> employees);

@BatchDelete(sqlFile = true, suppressOptimisticLockException = true)
int[] delete(List<Employee> employees);

クエリタイムアウト¶

@BatchDelete の queryTimeout 要素にクエリタイムアウトの秒数を指定できます。

@BatchDelete(queryTimeout = 10)
int[] delete(List<Employee> employees);

この指定は、SQLファイルの使用の有無に関係なく適用されます。 queryTimeout 要素に値を指定しない場合、 設定 に指定されたクエリタイムアウトが使用されます。

バッチサイズ¶

@BatchDelete の batchSize 要素にバッチサイズを指定できます。

@BatchDelete(batchSize = 10)
int[] delete(List<Employee> employees);

この設定は、SQLファイルの使用の有無に関係なく適用されます。 batchSize 要素に値を指定しない場合、 設定 に指定されたバッチサイズが使用されます。

SQL のログ出力形式¶

@BatchDelete の sqlLog 要素に SQL のログ出力形式を指定できます。

@BatchDelete(sqlLog = SqlLogType.RAW)
int[] delete(List<Employee> employees);

SqlLogType.RAW はバインドパラメータ（?）付きの SQL をログ出力することを表します。

戻り値¶

戻り値は次のいずれかでなければいけません。

ファンクション名¶

デフォルトではメソッド名がファンクション名になります。 @Function の name 要素に値を指定した場合は、その値がファンクション名になります。

@Function(name = "calculateSalary")
void execute(@In Integer id, @InOut Reference<BigDecimal> salary);

@Function の catalog 要素や schema 要素にカタログ名やスキーマ名を指定できます。 このときファンクションの名前は catalog 要素、 schema 要素、 name 要素 （指定されていなければメソッド名）をピリオドで連結したものになります。

@Function(catlog = "CATALOG", schema ="SCHEMA", name = "calculateSalary")
void execute(@In Integer id, @InOut Reference<BigDecimal> salary);

戻り値の型が エンティティクラス や エンティティクラス を要素とする java.util.List の場合において、 エンティティのプロパティすべてに対して漏れなく結果セットのカラムをマッピングすることを保証したい場合は、 @Function の ensureResultMapping 要素に true を指定します。

@Function(ensureResultMapping = true)
List<Employee> execute();

結果セットのカラムにマッピングされないプロパティが存在する場合 ResultMappingException がスローされます。

パラメータ¶

ストアドファンクションのパラメータとDaoメソッドのパラメータの並び順は合わせなければいけません。

@Function
void execute(@In Integer id);

EmployeeDao dao = new EmployeeDaoImpl();
dao.execute(1);

@Function
void execute(@InOut Reference<BigDecimal> salary);

EmployeeDao dao = new EmployeeDaoImpl();
BigDecimal in = new BigDecimal(100);
Reference<BigDecimal> ref = new Reference<BigDecimal>(in);
dao.execute(ref);
BigDecimal out = ref.get();

@Function
Integer execute(@Out Reference<BigDecimal> salary);

EmployeeDao dao = new EmployeeDaoImpl();
Reference<BigDecimal> ref = new Reference<BigDecimal>();
Integer result = dao.execute(ref);
BigDecimal out = ref.get();

@Function
void execute(@ResultSet List<Employee> employee);

EmployeeDao dao = new EmployeeDaoImpl();
List<Employee> employees = new ArrayList<Employee>();
dao.execute(employees);
for (Employee e : employees) {
    ...
}

@Function
void execute(@ResultSet(ensureResultMapping = true) List<Employee> employee);

マップのキーのネーミング規約¶

結果セットを java.util.Map<String, Object> にマッピングする場合、 @Function の mapKeyNaming 要素にマップのキーのネーミング規約を指定できます。

@Function(mapKeyNaming = MapKeyNamingType.CAMEL_CASE)
List<Map<String, Object>> execute(@In Integer id);