api-docs / org.ktorm.expression / ScalarExpression

ScalarExpression

abstract class ScalarExpression<T : Any> : 
    SqlExpression,
    ColumnDeclaring<T>

(source code)

Base class of scalar expressions. An expression is “scalar” if it has a return value (eg. a + 1).

Parameters

T - the return value’s type of this scalar expression.

Constructors

Name	Summary
<init>	`ScalarExpression()` Base class of scalar expressions. An expression is “scalar” if it has a return value (eg. `a + 1`).

Properties

Name	Summary
sqlType	`abstract val sqlType: SqlType<T>` The SqlType of this column or expression.

Inherited Properties

Name	Summary
extraProperties	`abstract val extraProperties: Map<String, Any>` Extra properties of this expression, maybe useful in SqlFormatter to generate some special SQLs.
isLeafNode	`abstract val isLeafNode: Boolean` Check if this expression is a leaf node in expression trees.

Functions

Name	Summary
aliased	`open fun aliased( label: String? ): ColumnDeclaringExpression<T>` Wrap this instance as a ColumnDeclaringExpression.
asExpression	`open fun asExpression(): ScalarExpression<T>` Convert this instance to a ScalarExpression.
wrapArgument	`open fun wrapArgument(argument: T?): ArgumentExpression<T>` Wrap the given argument as an ArgumentExpression using the sqlType.

Extension Functions

Name	Summary
and	`infix fun ColumnDeclaring<Boolean>.and( expr: ColumnDeclaring<Boolean> ): BinaryExpression<Boolean>` `infix fun ColumnDeclaring<Boolean>.and( value: Boolean ): BinaryExpression<Boolean>` And operator, translated to the `and` keyword in SQL.
asc	`fun ColumnDeclaring<*>.asc(): OrderByExpression` Order this column or expression in ascending order.
cast	`fun <T : Any> ColumnDeclaring<*>.cast( sqlType: SqlType<T> ): CastingExpression<T>` Cast the current column or expression to the given SqlType.
containedIn	`fun ColumnDeclaring<HStore>.containedIn( expr: ColumnDeclaring<HStore> ): HStoreExpression<Boolean>` `fun ColumnDeclaring<HStore>.containedIn( argument: HStore ): HStoreExpression<Boolean>` HStore contained-in operator, translated to the <@ operator in PostgreSQL.
contains	`fun ColumnDeclaring<Cube>.contains( expr: ColumnDeclaring<Cube> ): CubeExpression<Boolean>` `fun ColumnDeclaring<Cube>.contains( argument: Cube ): CubeExpression<Boolean>` `fun ColumnDeclaring<Cube>.contains( expr: ColumnDeclaring<Earth> ): CubeExpression<Boolean>` `fun ColumnDeclaring<Cube>.contains( argument: Earth ): CubeExpression<Boolean>` Cube contains operator, translated to the @> operator in PostgreSQL. `fun ColumnDeclaring<HStore>.contains( expr: ColumnDeclaring<HStore> ): HStoreExpression<Boolean>` `fun ColumnDeclaring<HStore>.contains( argument: HStore ): HStoreExpression<Boolean>` HStore contains operator, translated to the @> operator in PostgreSQL.
containsAll	`fun ColumnDeclaring<HStore>.containsAll( expr: ColumnDeclaring<TextArray> ): HStoreExpression<Boolean>` `fun ColumnDeclaring<HStore>.containsAll( argument: TextArray ): HStoreExpression<Boolean>` HStore contains-all-keys operator, translated to the ?& operator in PostgreSQL.
containsAny	`fun ColumnDeclaring<HStore>.containsAny( expr: ColumnDeclaring<TextArray> ): HStoreExpression<Boolean>` `fun ColumnDeclaring<HStore>.containsAny( argument: TextArray ): HStoreExpression<Boolean>` HStore contains-any-keys operator, translated to the ?\| operator in PostgreSQL.
containsKey	`fun ColumnDeclaring<HStore>.containsKey( expr: ColumnDeclaring<String> ): HStoreExpression<Boolean>` `fun ColumnDeclaring<HStore>.containsKey( argument: String ): HStoreExpression<Boolean>` HStore contains-key operator, translated to the ? operator in PostgreSQL.
desc	`fun ColumnDeclaring<*>.desc(): OrderByExpression` Order this column or expression in descending order, corresponding to the `desc` keyword in SQL.
div	`infix operator fun <T : Number> ColumnDeclaring<T>.div( expr: ColumnDeclaring<T> ): BinaryExpression<T>` `infix operator fun <T : Number> ColumnDeclaring<T>.div( value: T ): BinaryExpression<T>` Divide operator, translated to `/` in SQL.
eq	`infix fun <T : Any> ColumnDeclaring<T>.eq( expr: ColumnDeclaring<T> ): BinaryExpression<Boolean>` `infix fun <T : Any> ColumnDeclaring<T>.eq( value: T ): BinaryExpression<Boolean>` `infix fun <T : Any> T.eq( expr: ColumnDeclaring<T> ): BinaryExpression<Boolean>` Equal operator, translated to `=` in SQL.
get	`operator fun ColumnDeclaring<HStore>.get( expr: ColumnDeclaring<String> ): HStoreExpression<String>` `operator fun ColumnDeclaring<HStore>.get( argument: String ): HStoreExpression<String>` HStore get-value-for-key operator, translated to the -> operator in PostgreSQL. `operator fun ColumnDeclaring<HStore>.get( expr: ColumnDeclaring<TextArray> ): HStoreExpression<TextArray>` `operator fun ColumnDeclaring<HStore>.get( argument: TextArray ): HStoreExpression<TextArray>` HStore get-values-for-keys operator, translated to the -> operator in PostgreSQL.
ifNull	`fun <T : Any> ColumnDeclaring<T>.ifNull( right: ColumnDeclaring<T> ): FunctionExpression<T>` `fun <T : Any> ColumnDeclaring<T>.ifNull( right: T? ): FunctionExpression<T>` MySQL ifnull function, translated to `ifnull(left, right)`.
ifNull	`fun <T : Any> ColumnDeclaring<T>.ifNull( right: ColumnDeclaring<T> ): FunctionExpression<T>` `fun <T : Any> ColumnDeclaring<T>.ifNull( right: T? ): FunctionExpression<T>` SQLite ifnull function, translated to `ifnull(left, right)`.
ilike	`infix fun ColumnDeclaring<>.ilike( expr: ColumnDeclaring<String> ): ILikeExpression` `infix fun ColumnDeclaring<>.ilike( argument: String ): ILikeExpression` ILike operator, translated to the `ilike` keyword in PostgreSQL.
inList	`fun <T : Any> ColumnDeclaring<T>.inList( vararg list: T ): InListExpression` `infix fun <T : Any> ColumnDeclaring<T>.inList( list: Collection<T> ): InListExpression` `infix fun ColumnDeclaring<*>.inList( query: Query ): InListExpression` In-list operator, translated to the `in` keyword in SQL.
instr	`fun ColumnDeclaring<String>.instr( right: ColumnDeclaring<String> ): FunctionExpression<Int>` `fun ColumnDeclaring<String>.instr( right: String ): FunctionExpression<Int>` SQLite instr function, translated to `instr(left, right)`.
isNotNull	`fun ColumnDeclaring<*>.isNotNull(): UnaryExpression<Boolean>` Check if the current column or expression is not null, translated to `is not null` in SQL.
isNull	`fun ColumnDeclaring<*>.isNull(): UnaryExpression<Boolean>` Check if the current column or expression is null, translated to `is null` in SQL.
jsonExtract	`fun <T : Any> ColumnDeclaring<*>.jsonExtract( path: String, sqlType: SqlType<T> = SqlType.of() ?: error("Cannot detect the result's SqlType, please specify manually.") ): FunctionExpression<T>` SQLite json_extract function, translated to `json_extract(column, path)`.
jsonPatch	`fun ColumnDeclaring<>.jsonPatch( right: ColumnDeclaring<> ): FunctionExpression<String>` SQLite json_patch function, translated to `json_patch(left, right)`.
jsonRemove	`fun ColumnDeclaring<*>.jsonRemove( path: String ): FunctionExpression<String>` SQLite json_remove function, translated to `json_remove(column, path)`.
jsonValid	`fun ColumnDeclaring<*>.jsonValid(): FunctionExpression<Boolean>` SQLite json_valid function, translated to `json_valid(column)`.
like	`infix fun ColumnDeclaring<>.like( expr: ColumnDeclaring<String> ): BinaryExpression<Boolean>` `infix fun ColumnDeclaring<>.like( value: String ): BinaryExpression<Boolean>` Like operator, translated to the `like` keyword in SQL.
minus	`infix operator fun <T : Number> ColumnDeclaring<T>.minus( expr: ColumnDeclaring<T> ): BinaryExpression<T>` `infix operator fun <T : Number> ColumnDeclaring<T>.minus( value: T ): BinaryExpression<T>` Minus operator, translated to `-` in SQL.
minus	`operator fun ColumnDeclaring<HStore>.minus( expr: ColumnDeclaring<String> ): HStoreExpression<HStore>` `operator fun ColumnDeclaring<HStore>.minus( argument: String ): HStoreExpression<HStore>` HStore delete-key operator, translated to the - operator in PostgreSQL. `operator fun ColumnDeclaring<HStore>.minus( expr: ColumnDeclaring<TextArray> ): HStoreExpression<HStore>` `operator fun ColumnDeclaring<HStore>.minus( argument: TextArray ): HStoreExpression<HStore>` HStore delete-keys operator, translated to the - operator in PostgreSQL. `operator fun ColumnDeclaring<HStore>.minus( expr: ColumnDeclaring<HStore> ): HStoreExpression<HStore>` `operator fun ColumnDeclaring<HStore>.minus( argument: HStore ): HStoreExpression<HStore>` HStore delete-matching-pairs operator, translated to the - operator in PostgreSQL.
neq	`infix fun <T : Any> ColumnDeclaring<T>.neq( expr: ColumnDeclaring<T> ): BinaryExpression<Boolean>` `infix fun <T : Any> ColumnDeclaring<T>.neq( value: T ): BinaryExpression<Boolean>` `infix fun <T : Any> T.neq( expr: ColumnDeclaring<T> ): BinaryExpression<Boolean>` Not-equal operator, translated to `<>` in SQL.
not	`operator fun ColumnDeclaring<Boolean>.not(): UnaryExpression<Boolean>` Negative operator, translated to the `not` keyword in SQL.
notEq	`infix fun <T : Any> ColumnDeclaring<T>.notEq( expr: ColumnDeclaring<T> ): BinaryExpression<Boolean>` `infix fun <T : Any> ColumnDeclaring<T>.notEq( value: T ): BinaryExpression<Boolean>` `infix fun <T : Any> T.notEq( expr: ColumnDeclaring<T> ): BinaryExpression<Boolean>` Not-equal operator, translated to `<>` in SQL.
notInList	`fun <T : Any> ColumnDeclaring<T>.notInList( vararg list: T ): InListExpression` `infix fun <T : Any> ColumnDeclaring<T>.notInList( list: Collection<T> ): InListExpression` `infix fun ColumnDeclaring<*>.notInList( query: Query ): InListExpression` Not-in-list operator, translated to the `not in` keyword in SQL.
notLike	`infix fun ColumnDeclaring<>.notLike( expr: ColumnDeclaring<String> ): BinaryExpression<Boolean>` `infix fun ColumnDeclaring<>.notLike( value: String ): BinaryExpression<Boolean>` Not like operator, translated to the `not like` keyword in SQL.
or	`infix fun ColumnDeclaring<Boolean>.or( expr: ColumnDeclaring<Boolean> ): BinaryExpression<Boolean>` `infix fun ColumnDeclaring<Boolean>.or( value: Boolean ): BinaryExpression<Boolean>` Or operator, translated to the `or` keyword in SQL.
overlaps	`fun ColumnDeclaring<Cube>.overlaps( expr: ColumnDeclaring<Cube> ): CubeExpression<Boolean>` `fun ColumnDeclaring<Cube>.overlaps( argument: Cube ): CubeExpression<Boolean>` Cube overlap operator, translated to the && operator in PostgreSQL.
plus	`infix operator fun <T : Number> ColumnDeclaring<T>.plus( expr: ColumnDeclaring<T> ): BinaryExpression<T>` `infix operator fun <T : Number> ColumnDeclaring<T>.plus( value: T ): BinaryExpression<T>` Plus operator, translated to `+` in SQL.
plus	`operator fun ColumnDeclaring<HStore>.plus( expr: ColumnDeclaring<HStore> ): HStoreExpression<HStore>` `operator fun ColumnDeclaring<HStore>.plus( argument: HStore ): HStoreExpression<HStore>` HStore concatenate operator, translated to the \|\| operator in PostgreSQL.
rem	`infix operator fun <T : Number> ColumnDeclaring<T>.rem( expr: ColumnDeclaring<T> ): BinaryExpression<T>` `infix operator fun <T : Number> ColumnDeclaring<T>.rem( value: T ): BinaryExpression<T>` Mod operator, translated to `%` in SQL.
times	`infix operator fun <T : Number> ColumnDeclaring<T>.times( expr: ColumnDeclaring<T> ): BinaryExpression<T>` `infix operator fun <T : Number> ColumnDeclaring<T>.times( value: T ): BinaryExpression<T>` Multiply operator, translated to `*` in SQL.
toDouble	`fun ColumnDeclaring<out Number>.toDouble(): CastingExpression<Double>` Cast the current column or expression’s type to Double.
toFloat	`fun ColumnDeclaring<out Number>.toFloat(): CastingExpression<Float>` Cast the current column or expression’s type to Float.
toLong	`fun ColumnDeclaring<out Number>.toLong(): CastingExpression<Long>` Cast the current column or expression’s type to Long.
toShort	`fun ColumnDeclaring<out Number>.toShort(): CastingExpression<Short>` Cast the current column or expression’s type to Short.
unaryMinus	`operator fun <T : Number> ColumnDeclaring<T>.unaryMinus(): UnaryExpression<T>` Unary minus operator, translated to `-` in SQL.
unaryPlus	`operator fun <T : Number> ColumnDeclaring<T>.unaryPlus(): UnaryExpression<T>` Unary plus operator, translated to `+` in SQL.
xor	`infix fun ColumnDeclaring<Boolean>.xor( expr: ColumnDeclaring<Boolean> ): BinaryExpression<Boolean>` `infix fun ColumnDeclaring<Boolean>.xor( value: Boolean ): BinaryExpression<Boolean>` Xor operator, translated to the `xor` keyword in SQL.

Inheritors

Name	Summary
AggregateExpression	`data class AggregateExpression<T : Any> : ScalarExpression<T>` Aggregate expression.
ArgumentExpression	`data class ArgumentExpression<T : Any> : ScalarExpression<T>` Argument expression, wraps an argument passed to the executed SQL.
BetweenExpression	`data class BetweenExpression : ScalarExpression<Boolean>` Between expression, check if a scalar expression is in the given range.
BinaryExpression	`data class BinaryExpression<T : Any> : ScalarExpression<T>` Binary expression.
CaseWhenExpression	`data class CaseWhenExpression<T : Any> : ScalarExpression<T>` Case-when expression, represents a SQL case-when clause.
CastingExpression	`data class CastingExpression<T : Any> : ScalarExpression<T>` Wrap a SQL expression, changing its return type, translated to SQl cast(expr as type).
ColumnDeclaringExpression	`data class ColumnDeclaringExpression<T : Any> : ScalarExpression<T>` Column declaring expression, represents the selected columns in a SelectExpression.
ColumnExpression	`data class ColumnExpression<T : Any> : ScalarExpression<T>` Column expression.
CubeExpression	`data class CubeExpression<T : Any> : ScalarExpression<T>` Expression class represents PostgreSQL `Cube` operations.
DefaultValueExpression	`data class DefaultValueExpression<T : Any> : ScalarExpression<T>` Default value expression, translated to the `default` keyword in MySQL, used in insert statements.
DefaultValueExpression	`data class DefaultValueExpression<T : Any> : ScalarExpression<T>` Default value expression, translated to the `default` keyword in PostgreSQL, used in insert statements.
ExistsExpression	`data class ExistsExpression : ScalarExpression<Boolean>` Exists expression, check if the specific query has at least one result.
FunctionExpression	`data class FunctionExpression<T : Any> : ScalarExpression<T>` Function expression, represents a normal SQL function call.
HStoreExpression	`data class HStoreExpression<T : Any> : ScalarExpression<T>` Expression class represents PostgreSQL `hstore` operations.
ILikeExpression	`data class ILikeExpression : ScalarExpression<Boolean>` ILike expression, represents PostgreSQL `ilike` keyword.
InListExpression	`data class InListExpression : ScalarExpression<Boolean>` In-list expression, translated to the `in` keyword in SQL.
MatchAgainstExpression	`data class MatchAgainstExpression : ScalarExpression<Boolean>` Match against expression, represents an `match ... against ...` operation in MySQL. See https://dev.mysql.com/doc/refman/5.5/en/insert-on-duplicate.html
UnaryExpression	`data class UnaryExpression<T : Any> : ScalarExpression<T>` Unary expression.
WindowFunctionExpression	`data class WindowFunctionExpression<T : Any> : ScalarExpression<T>` Window function expression, represents a SQL window function call.