exposed-core/org.jetbrains.exposed.sql/Expression

Expression

abstract class Expression<T>

Represents an SQL expression of type T.

Inheritors

ExpressionAlias

CompositeColumn

ExpressionWithColumnType

QueryParameter

Constructors

Expression

constructor()

Types

Companion

object Companion

Functions

alias

fun <T> Expression<T>.alias(alias: String): ExpressionAlias<T>

Creates a temporary identifier, alias, for this expression.

and

inline fun Expression<Boolean>.and(op: SqlExpressionBuilder.() -> Op<Boolean>): Op<Boolean>

infix fun Expression<Boolean>.and(op: Expression<Boolean>): Op<Boolean>

Returns the result of performing a logical and operation between this expression and the op.

andNot

inline fun Expression<Boolean>.andNot(op: SqlExpressionBuilder.() -> Op<Boolean>): Op<Boolean>

Returns the result of performing a logical and operation between this expression and the negate op.

castTo

fun <R> Expression<*>.castTo(columnType: IColumnType<R & Any>): ExpressionWithColumnType<R>

Specifies a conversion from one data type to another.

charLength

fun <T : String?> Expression<T>.charLength(): CharLength<T>

Returns the length of this string expression, measured in characters, or null if this expression is null.

open infix fun <T, S1 : T?, S2 : T?> Expression<in S1>.eq(other: Expression<in S2>): Op<Boolean>

Checks if this expression is equal to some other expression.

open infix fun <T : Any, V : T?, E : EntityID<T>?> Expression<V>.eq(other: ExpressionWithColumnType<E>): Op<Boolean>

Checks if this expression is equal to some other expression.

eqSubQuery

open infix fun <T> Expression<T>.eqSubQuery(query: AbstractQuery<*>): EqSubQueryOp<T>

Checks if this expression is equals to single value returned from query.

equals

open operator override fun equals(other: Any?): Boolean

greater

open infix fun <T : Comparable<T>, V : T?, E : EntityID<T>?> Expression<V>.greater(other: ExpressionWithColumnType<E>): GreaterOp

Checks if this expression is greater than some other expression.

open infix fun <T : Comparable<T>, S : T?> Expression<in S>.greater(other: Expression<in S>): GreaterOp

Checks if this expression is greater than some other expression.

greaterEq

open infix fun <T : Comparable<T>, V : T?, E : EntityID<T>?> Expression<V>.greaterEq(other: ExpressionWithColumnType<E>): GreaterEqOp

Checks if this expression is greater than or equal to some other expression.

open infix fun <T : Comparable<T>, S : T?> Expression<in S>.greaterEq(other: Expression<in S>): GreaterEqOp

Checks if this expression is greater than or equal to some other expression

groupConcat

fun <T : String?> Expression<T>.groupConcat(separator: String? = null, distinct: Boolean = false, orderBy: Array<Pair<Expression<*>, SortOrder>> = emptyArray()): GroupConcat<T>

fun <T : String?> Expression<T>.groupConcat(separator: String? = null, distinct: Boolean = false, orderBy: Pair<Expression<*>, SortOrder>): GroupConcat<T>

Concatenates all non-null input values of each group from this string expression, separated by separator.

hashCode

open override fun hashCode(): Int

inSubQuery

open infix fun <T> Expression<T>.inSubQuery(query: AbstractQuery<*>): InSubQueryOp<T>

Checks if this expression is equals to any row returned from query.

isDistinctFrom

open infix fun <T : Any, V : T?, E : EntityID<T>?> Expression<in V>.isDistinctFrom(other: ExpressionWithColumnType<E>): IsDistinctFromOp

Checks if this expression is not equal to some other expression.

open infix fun <T : Comparable<T>, S : T?> Expression<in S>.isDistinctFrom(other: Expression<in S>): IsDistinctFromOp

Checks if this expression is not equal to some other expression, with null treated as a comparable value

isNotDistinctFrom

open infix fun <T : Any, V : T?, E : EntityID<T>?> Expression<V>.isNotDistinctFrom(other: ExpressionWithColumnType<E>): IsNotDistinctFromOp

Checks if this expression is equal to some other expression.

open infix fun <T : Comparable<T>, S : T?> Expression<in S>.isNotDistinctFrom(other: Expression<in S>): IsNotDistinctFromOp

Checks if this expression is equal to some other expression, with null treated as a comparable value

isNotNull

open fun <T> Expression<T>.isNotNull(): Op<Boolean>

Returns true if this expression is not null, false otherwise.

isNull

open fun <T> Expression<T>.isNull(): Op<Boolean>

Returns true if this expression is null, false otherwise.

isNullOrEmpty

open fun <T : String?> Expression<T>.isNullOrEmpty(): Op<Boolean>

Returns true if this string expression is null or empty, false otherwise.

less

open infix fun <T : Comparable<T>, V : T?, E : EntityID<T>?> Expression<V>.less(other: ExpressionWithColumnType<E>): LessOp

Checks if this expression is less than some other expression.

open infix fun <T : Comparable<T>, S : T?> Expression<in S>.less(other: Expression<in S>): LessOp

Checks if this expression is less than some other expression.

lessEq

open infix fun <T : Comparable<T>, V : T?, E : EntityID<T>?> Expression<V>.lessEq(other: ExpressionWithColumnType<E>): LessEqOp

Checks if this expression is less than or equal to some other expression.

open infix fun <T : Comparable<T>, S : T?> Expression<in S>.lessEq(other: Expression<in S>): LessEqOp

Checks if this expression is less than or equal to some other expression

open infix fun <T : String?> Expression<T>.like(pattern: String): LikeEscapeOp

open infix fun <T : String?> Expression<T>.like(pattern: LikePattern): LikeEscapeOp

@JvmName(name = "likeWithEntityID")

open infix fun Expression<EntityID<String>>.like(pattern: String): LikeEscapeOp

@JvmName(name = "likeWithEntityID")

open infix fun Expression<EntityID<String>>.like(pattern: LikePattern): LikeEscapeOp

Checks if this expression matches the specified pattern.

open infix fun <T : String?> Expression<T>.like(expression: ExpressionWithColumnType<String>): LikeEscapeOp

@JvmName(name = "likeWithEntityIDAndExpression")

open infix fun Expression<EntityID<String>>.like(expression: ExpressionWithColumnType<String>): LikeEscapeOp

Checks if this expression matches the specified expression.

locate

fun <T : String?> Expression<T>.locate(substring: String): Locate<T>

Returns the index of the first occurrence of substring in this string expression or 0 if it doesn't contain substring

lowerCase

fun <T : String?> Expression<T>.lowerCase(): LowerCase<T>

Converts this string expression to lower case.

match

open infix fun <T : String?> Expression<T>.match(pattern: String): Op<Boolean>

Checks if this expression matches the specified pattern.

open fun <T : String?> Expression<T>.match(pattern: String, mode: FunctionProvider.MatchMode?): Op<Boolean>

Checks if this expression matches the specified pattern using the specified match mode.

mod

@JvmName(name = "modWithEntityId2")

open infix fun <T : Number, Comparable<T>, S : Number, ID : EntityID<T>?> Expression<S>.mod(other: ExpressionWithColumnType<ID>): ExpressionWithColumnType<T>

Calculates the remainder of dividing this number expression by other numeric PK

neq

open infix fun <T, S1 : T?, S2 : T?> Expression<in S1>.neq(other: Expression<in S2>): Op<Boolean>

Checks if this expression is not equal to some other expression.

open infix fun <T : Any, V : T?, E : EntityID<T>?> Expression<V>.neq(other: ExpressionWithColumnType<E>): Op<Boolean>

Checks if this expression is not equal to some other expression.

notEqSubQuery

open infix fun <T> Expression<T>.notEqSubQuery(query: AbstractQuery<*>): NotEqSubQueryOp<T>

Checks if this expression is not equals to single value returned from query.

notInSubQuery

open infix fun <T> Expression<T>.notInSubQuery(query: AbstractQuery<*>): NotInSubQueryOp<T>

Checks if this expression is not equals to any row returned from query.

notLike

open infix fun <T : String?> Expression<T>.notLike(pattern: String): LikeEscapeOp

open infix fun <T : String?> Expression<T>.notLike(pattern: LikePattern): LikeEscapeOp

@JvmName(name = "notLikeWithEntityID")

open infix fun Expression<EntityID<String>>.notLike(pattern: String): LikeEscapeOp

@JvmName(name = "notLikeWithEntityID")

open infix fun Expression<EntityID<String>>.notLike(pattern: LikePattern): LikeEscapeOp

Checks if this expression doesn't match the specified pattern.

open infix fun <T : String?> Expression<T>.notLike(expression: ExpressionWithColumnType<String>): LikeEscapeOp

Checks if this expression doesn't match the specified pattern.

@JvmName(name = "notLikeWithEntityIDAndExpression")

open infix fun Expression<EntityID<String>>.notLike(expression: ExpressionWithColumnType<String>): LikeEscapeOp

Checks if this expression doesn't match the specified expression.

inline fun Expression<Boolean>.or(op: SqlExpressionBuilder.() -> Op<Boolean>): Op<Boolean>

infix fun Expression<Boolean>.or(op: Expression<Boolean>): Op<Boolean>

Returns the result of performing a logical or operation between this expression and the op.

orNot

inline fun Expression<Boolean>.orNot(op: SqlExpressionBuilder.() -> Op<Boolean>): Op<Boolean>

Returns the result of performing a logical or operation between this expression and the negate op.

plus

open infix operator fun Expression<String>.plus(value: String): Concat

open infix operator fun Expression<String>.plus(value: Expression<String>): Concat

Concatenate the value to the input expression.

regexp

open infix fun <T : String?> Expression<T>.regexp(pattern: String): RegexpOp<T>

open fun <T : String?> Expression<T>.regexp(pattern: Expression<String>, caseSensitive: Boolean = true): RegexpOp<T>

Checks if this expression matches the pattern. Supports regular expressions.

rem

@JvmName(name = "remWithEntityId2")

open infix operator fun <T : Number, Comparable<T>, S : Number, ID : EntityID<T>?> Expression<S>.rem(other: ExpressionWithColumnType<ID>): ExpressionWithColumnType<T>

Calculates the remainder of dividing this number expression by other numeric PK

substring

fun <T : String?> Expression<T>.substring(start: Int, length: Int): Substring<T>

Extract a substring from this string expression that begins at the specified start and with the specified length.

toQueryBuilder

abstract fun toQueryBuilder(queryBuilder: QueryBuilder)

Appends the SQL representation of this expression to the specified queryBuilder.

toString

open override fun toString(): String

trim

fun <T : String?> Expression<T>.trim(): Trim<T>

Removes the longest string containing only spaces from both ends of string expression.

upperCase

fun <T : String?> Expression<T>.upperCase(): UpperCase<T>

Converts this string expression to upper case.