ktorm-core/org.ktorm.expression/WindowSpecificationExpression

WindowSpecificationExpression

data class WindowSpecificationExpression(val partitionBy: List<ScalarExpression<*>> = emptyList(), val orderBy: List<OrderByExpression> = emptyList(), val frameUnit: WindowFrameUnitType? = null, val frameStart: WindowFrameBoundExpression? = null, val frameEnd: WindowFrameBoundExpression? = null, val isLeafNode: Boolean = false, val extraProperties: Map<String, Any> = emptyMap()) : SqlExpression(source)

Window specification expression.

Since

3.6.0

Constructors

WindowSpecificationExpression

constructor(partitionBy: List<ScalarExpression<*>> = emptyList(), orderBy: List<OrderByExpression> = emptyList(), frameUnit: WindowFrameUnitType? = null, frameStart: WindowFrameBoundExpression? = null, frameEnd: WindowFrameBoundExpression? = null, isLeafNode: Boolean = false, extraProperties: Map<String, Any> = emptyMap())

Properties

extraProperties

open override val extraProperties: Map<String, Any>

Extra properties of this expression, maybe useful in SqlFormatter to generate some special SQLs.

frameEnd

val frameEnd: WindowFrameBoundExpression? = null

end bound of the window frame.

frameStart

val frameStart: WindowFrameBoundExpression? = null

start bound of the window frame.

frameUnit

val frameUnit: WindowFrameUnitType? = null

frame unit indicates the type of relationship between the current row and frame rows.

isLeafNode

open override val isLeafNode: Boolean = false

Check if this expression is a leaf node in expression trees.

orderBy

val orderBy: List<OrderByExpression>

order-by clause indicates how to sort rows in each partition.

partitionBy

val partitionBy: List<ScalarExpression<*>>

partition-by clause indicates how to divide the query rows into groups.

Functions

orderBy

fun WindowSpecificationExpression.orderBy(vararg orders: OrderByExpression): WindowSpecificationExpression

fun WindowSpecificationExpression.orderBy(orders: Collection<OrderByExpression>): WindowSpecificationExpression

Specify the order-by clause of this window using the given order-by expressions.

partitionBy

fun WindowSpecificationExpression.partitionBy(vararg columns: ColumnDeclaring<*>): WindowSpecificationExpression

fun WindowSpecificationExpression.partitionBy(columns: Collection<ColumnDeclaring<*>>): WindowSpecificationExpression

Specify the partition-by clause of this window using the given columns or expressions.

range

fun WindowSpecificationExpression.range(bound: WindowFrameBoundExpression): WindowSpecificationExpression

Specify the frame clause of this window using the given bound in range unit.

rangeBetween

fun WindowSpecificationExpression.rangeBetween(start: WindowFrameBoundExpression, end: WindowFrameBoundExpression): WindowSpecificationExpression

Specify the frame clause of this window using the given bounds (start & end) in rows unit.

rows

fun WindowSpecificationExpression.rows(bound: WindowFrameBoundExpression): WindowSpecificationExpression

Specify the frame clause of this window using the given bound in rows unit.

rowsBetween

fun WindowSpecificationExpression.rowsBetween(start: WindowFrameBoundExpression, end: WindowFrameBoundExpression): WindowSpecificationExpression

Specify the frame clause of this window using the given bounds (start & end) in rows unit.