Version v1.0 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.

クエリビルダー

クエリの部品を組み立てるAPI

概要

QueryDslで構築可能なクエリ全体の一部を部品として定義し、それらを組み立てることで1つのクエリを構築できます。部品を定義する関数をビルダーと呼びます。ビルダー関数はすべてorg.komapper.core.dsl.queryに定義されます。

where

Where宣言を組み立てるビルダーです。

val salaryWhere = where {
  e.salary greater BigDecimal(1_000)
}
val query: Query<List<Employee>> = QueryDsl.from(e).where(salaryWhere)

on

On宣言を組み立てるビルダーです。

val departmentIdOn = on {
    e.departmentId eq d.departmentId
}
val query: Query<List<Employee>> = QueryDsl.from(e).innerJoin(d, departmentIdOn)

having

Having宣言を組み立てるビルダーです。

val countHaving = having {
    count() greater 3
}
val query: Query<List<Int?>> = QueryDsl.from(e)
    .groupBy(e.departmentId)
    .having(countHaving)
    .select(e.departmentId)

set

Assignment宣言を組み立てるビルダーです。

val addressAssignment = set(a) {
    a.street eq "STREET 16"
}
val query: Query<Int> = QueryDsl.update(a).set(addressAssignment).where {
    a.addressId eq 1
}

values

Assignment宣言を組み立てるビルダーです。

val addressAssignment = set(a) {
    a.street eq "STREET 16"
}
val query: Query<Pair<Int, Int?>> = QueryDsl.insert(a).values(addressAssignment)

join

Join要素を組み立てるビルダーです。

join関数により得られた値は、クエリのinnerJoinやleftJoinの関数に渡せます。

val departmentJoin = join(d) {
    e.departmentId eq d.departmentId
}

val query1: Query<List<Employee>> = QueryDsl.from(e).innerJoin(departmentJoin)
val query2: Query<List<Employee>> = QueryDsl.from(e).leftJoin(departmentJoin)

groupBy

GroupBy要素を組み立てるビルダーです。

val groupByDepartmentId = groupBy(e.departmentId)
val query: Query<List<Int?>> = QueryDsl.from(e)
    .groupBy(groupByDepartmentId)
    .having {
        count() greater 3
    }
    .select(e.departmentId)

orderBy

OrderBy要素を組み立てるビルダーです。

val orderBySalaryAndNo = orderBy( e.salary, e.employeeNo)
val query: Query<List<Employee>> = QueryDsl.from(e).orderBy(orderBySalaryAndNo)

最終更新 March 11, 2022: Update the title and linkTitle (cf9ed4f)