English | 简体中文

api-docs / org.ktorm.dsl / WindowFrames

WindowFrames

object WindowFrames (source code)

Utility object that creates expressions of window frame bounds.

Since
3.6.0

Functions

NameSummary

currentRow

fun currentRow(): WindowFrameBoundExpression

Create a bound expression that represents current row.

following

fun <T : Number> following(
    n: T,
    sqlType: SqlType<T> = SqlType.of() ?: error("Cannot detect the argument's SqlType, please specify manually.")
): WindowFrameBoundExpression

Create a bound expression that represents N following.

preceding

fun <T : Number> preceding(
    n: T,
    sqlType: SqlType<T> = SqlType.of() ?: error("Cannot detect the argument's SqlType, please specify manually.")
): WindowFrameBoundExpression

Create a bound expression that represents N preceding.

unboundedFollowing

fun unboundedFollowing(): WindowFrameBoundExpression

Create a bound expression that represents unbounded following, which means the last partition row.

unboundedPreceding

fun unboundedPreceding(): WindowFrameBoundExpression

Create a bound expression that represents unbounded preceding, which means the first partition row.

Extension Functions

NameSummary

eq

infix fun <T : Any> T.eq(
    expr: ColumnDeclaring<T>
): BinaryExpression<Boolean>

Equal operator, translated to = in SQL.

neq

infix fun <T : Any> T.neq(
    expr: ColumnDeclaring<T>
): BinaryExpression<Boolean>

Not-equal operator, translated to <> in SQL.

notEq

infix fun <T : Any> T.notEq(
    expr: ColumnDeclaring<T>
): BinaryExpression<Boolean>

Not-equal operator, translated to <> in SQL.