English |

简体中文

api-docs / org.ktorm.expression / OrderByExpression

OrderByExpression

data class OrderByExpression : SqlExpression (source code)

Order-by expression.

Constructors

Name	Summary
<init>	`OrderByExpression( expression: ScalarExpression<*>, orderType: OrderType, isLeafNode: Boolean = false, extraProperties: Map<String, Any> = emptyMap())` Order-by expression.

Properties

Name	Summary
expression	`val expression: ScalarExpression<*>` the sorting column, might be a ColumnExpression or other scalar expression types.
extraProperties	`val extraProperties: Map<String, Any>` Extra properties of this expression, maybe useful in SqlFormatter to generate some special SQLs.
isLeafNode	`val isLeafNode: Boolean` Check if this expression is a leaf node in expression trees.
orderType	`val orderType: OrderType` the sorting direction.

Extension Functions

Name	Summary
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.