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

SqlExpressionBuilder

object SqlExpressionBuilder : ISqlExpressionBuilder

Builder object for creating SQL expressions.

Functions

asLiteral

open fun <T, S : T?> ExpressionWithColumnType<S>.asLiteral(value: T): LiteralOp<T>

Returns the specified value as a literal of type T.

between

open fun <T : Comparable<T>, E : EntityID<T>?> Column<E>.between(from: T, to: T): Between

Returns true if this EntityID expression is between the values from and to, false otherwise.

open fun <T, S : T?> ExpressionWithColumnType<in S>.between(from: T, to: T): Between

Returns true if this expression is between the values from and to, false otherwise.

bitwiseAnd

open infix fun <T> ExpressionWithColumnType<T>.bitwiseAnd(t: T): AndBitOp<T, T>

Performs a bitwise and on this expression and t.

open infix fun <T> ExpressionWithColumnType<T>.bitwiseAnd(t: Expression<T>): AndBitOp<T, T>

Performs a bitwise and on this expression and expression t.

bitwiseOr

open infix fun <T> ExpressionWithColumnType<T>.bitwiseOr(t: T): OrBitOp<T, T>

Performs a bitwise or on this expression and t.

open infix fun <T> ExpressionWithColumnType<T>.bitwiseOr(t: Expression<T>): OrBitOp<T, T>

Performs a bitwise or on this expression and expression t.

bitwiseXor

open infix fun <T> ExpressionWithColumnType<T>.bitwiseXor(t: T): XorBitOp<T, T>

Performs a bitwise or on this expression and t.

open infix fun <T> ExpressionWithColumnType<T>.bitwiseXor(t: Expression<T>): XorBitOp<T, T>

Performs a bitwise or on this expression and expression t.

case

open fun case(value: Expression<*>? = null): Case

Compares value against any chained conditional expressions.

coalesce

open fun <T, S : T?> coalesce(expr: ExpressionWithColumnType<S>, alternate: Expression<out T>, vararg others: Expression<out T>): Coalesce<T, S>

Returns the first of its arguments that is not null.

concat

open fun concat(vararg expr: Expression<*>): Concat

Concatenates the text representations of all the expr.

open fun concat(separator: String = "", expr: List<Expression<*>>): Concat

Concatenates the text representations of all the expr using the specified separator.

cumeDist

open fun cumeDist(): CumeDist

Returns the cumulative distribution, that is (number of partition rows preceding or peers with current row) / (total partition rows). The value thus ranges from 1/N to 1.

denseRank

open fun denseRank(): DenseRank

Returns the rank of the current row, without gaps; this function effectively counts peer groups.

div

open infix operator fun <T> ExpressionWithColumnType<T>.div(t: T): DivideOp<T, T>

Divides this expression by the t value.

open infix operator fun <T, S : T> ExpressionWithColumnType<T>.div(other: Expression<S>): DivideOp<T, S>

Divides this expression by the other expression.

open infix fun <T> CompositeColumn<T>.eq(t: T): Op<Boolean>

open infix fun <T> ExpressionWithColumnType<T>.eq(t: T): Op<Boolean>

Checks if this expression is equal to some t value.

open infix fun <T : Comparable<T>, E : EntityID<T>?, V : T?> ExpressionWithColumnType<E>.eq(t: V): Op<Boolean>

Checks if this EntityID expression is equal to some t value.

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

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

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 : Comparable<T>, 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.

firstValue

open fun <T> ExpressionWithColumnType<T>.firstValue(): FirstValue<T>

Returns value evaluated at the row that is the first row of the window frame.

greater

@JvmName(name = "greaterEntityID")

open infix fun <T : Comparable<T>> Column<EntityID<T>>.greater(t: T): GreaterOp

Checks if this EntityID expression is greater than some t value.

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

Checks if this expression is greater than some t value.

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

Checks if this EntityID expression is greater than some other expression.

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

@JvmName(name = "greaterEqEntityID")

open infix fun <T : Comparable<T>> Column<EntityID<T>>.greaterEq(t: T): GreaterEqOp

Checks if this EntityID expression is greater than or equal to some t value

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

Checks if this expression is greater than or equal to some t value

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

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

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

hasFlag

open infix fun <T> ExpressionWithColumnType<T>.hasFlag(t: T): EqOp

Performs a bitwise and on this expression and t.

open infix fun <T> ExpressionWithColumnType<T>.hasFlag(t: Expression<T>): EqOp

Performs a bitwise and on this expression and expression t.

inList

open infix fun <T1, T2> Pair<ExpressionWithColumnType<T1>, ExpressionWithColumnType<T2>>.inList(list: Iterable<Pair<T1, T2>>): InListOrNotInListBaseOp<Pair<T1, T2>>

Checks if expressions from this Pair are equal to elements from list. This syntax is unsupported by SQL Server.

open infix fun <T1, T2, T3> Triple<ExpressionWithColumnType<T1>, ExpressionWithColumnType<T2>, ExpressionWithColumnType<T3>>.inList(list: Iterable<Triple<T1, T2, T3>>): InListOrNotInListBaseOp<Triple<T1, T2, T3>>

Checks if expressions from this Triple are equal to elements from list. This syntax is unsupported by SQL Server.

open infix fun List<Column<*>>.inList(list: Iterable<List<*>>): InListOrNotInListBaseOp<List<*>>

Checks if all columns in this List are equal to any of the lists of values from list.

@JvmName(name = "inListCompositeIDs")

open infix fun List<Column<*>>.inList(list: Iterable<CompositeID>): InListOrNotInListBaseOp<List<*>>

Checks if all columns in this List are equal to any of the CompositeIDs from list.

@JvmName(name = "inListIds")

open infix fun <T : Comparable<T>, ID : EntityID<T>?> Column<ID>.inList(list: Iterable<T>): InListOrNotInListBaseOp<EntityID<T>?>

@JvmName(name = "inListCompositeEntityIds")

open infix fun <ID : EntityID<CompositeID>> Column<ID>.inList(list: Iterable<CompositeID>): InListOrNotInListBaseOp<List<*>>

Checks if this EntityID column is equal to any element from list.

open infix fun <T> ExpressionWithColumnType<T>.inList(list: Iterable<T>): InListOrNotInListBaseOp<T>

Checks if this expression is equal to any element from list.

inSubQuery

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

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

inTable

open infix fun <T> ExpressionWithColumnType<T>.inTable(table: Table): InTableOp

Checks if this expression is equal to any element from the column of table with only a single column.

intToDecimal

open fun ExpressionWithColumnType<Int>.intToDecimal(): NoOpConversion<Int, BigDecimal>

isDistinctFrom

@JvmName(name = "isDistinctFromEntityID")

open infix fun <T : Comparable<T>> Column<EntityID<T>>.isDistinctFrom(t: T): IsDistinctFromOp

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

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

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

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

open infix fun <T : Comparable<T>, 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

@JvmName(name = "isNotDistinctFromEntityID")

open infix fun <T : Comparable<T>> Column<EntityID<T>>.isNotDistinctFrom(t: T): IsNotDistinctFromOp

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

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

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

Checks if this EntityID expression is equal to some other expression

open infix fun <T : Comparable<T>, 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.

lag

open fun <T> ExpressionWithColumnType<T>.lag(offset: ExpressionWithColumnType<Int> = intLiteral(1), defaultValue: ExpressionWithColumnType<T>? = null): Lag<T>

Returns value evaluated at the row that is offset rows before the current row within the partition; if there is no such row, instead returns defaultValue. Both offset and defaultValue are evaluated with respect to the current row.

lastValue

open fun <T> ExpressionWithColumnType<T>.lastValue(): LastValue<T>

Returns value evaluated at the row that is the last row of the window frame.

lead

open fun <T> ExpressionWithColumnType<T>.lead(offset: ExpressionWithColumnType<Int> = intLiteral(1), defaultValue: ExpressionWithColumnType<T>? = null): Lead<T>

Returns value evaluated at the row that is offset rows after the current row within the partition; if there is no such row, instead returns defaultValue. Both offset and defaultValue are evaluated with respect to the current row.

less

@JvmName(name = "lessEntityID")

open infix fun <T : Comparable<T>> Column<EntityID<T>>.less(t: T): LessOp

Checks if this EntityID expression is less than some t value.

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

Checks if this expression is less than some t value.

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

Checks if this EntityID expression is less than some other expression.

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

@JvmName(name = "lessEqEntityID")

open infix fun <T : Comparable<T>> Column<EntityID<T>>.lessEq(t: T): LessEqOp

Checks if this EntityID expression is less than or equal to some t value

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

Checks if this expression is less than or equal to some t value

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

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

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.

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.

minus

open infix operator fun <T> ExpressionWithColumnType<T>.minus(t: T): MinusOp<T, T>

Subtracts the t value from this expression.

open infix operator fun <T, S : T> ExpressionWithColumnType<T>.minus(other: Expression<S>): MinusOp<T, S>

Subtracts the other expression from this expression.

mod

open infix fun <T : Number?, S : T> ExpressionWithColumnType<T>.mod(t: S): ModOp<T, S, T>

Calculates the remainder of dividing this expression by the t value.

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

Calculates the remainder of dividing this expression by the other expression.

@JvmName(name = "modWithEntityId")

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

Calculates the remainder of dividing the value of this numeric PK by the other number.

@JvmName(name = "modWithEntityId3")

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

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

@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> ExpressionWithColumnType<T>.neq(other: T): Op<Boolean>

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

open infix fun <T : Comparable<T>, E : EntityID<T>?, V : T?> ExpressionWithColumnType<E>.neq(t: V): Op<Boolean>

Checks if this EntityID expression is not equal to some t value.

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

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

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 : Comparable<T>, 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.

notInList

open infix fun <T1, T2> Pair<ExpressionWithColumnType<T1>, ExpressionWithColumnType<T2>>.notInList(list: Iterable<Pair<T1, T2>>): InListOrNotInListBaseOp<Pair<T1, T2>>

Checks if expressions from this Pair are not equal to elements from list. This syntax is unsupported by SQL Server.

open infix fun <T1, T2, T3> Triple<ExpressionWithColumnType<T1>, ExpressionWithColumnType<T2>, ExpressionWithColumnType<T3>>.notInList(list: Iterable<Triple<T1, T2, T3>>): InListOrNotInListBaseOp<Triple<T1, T2, T3>>

Checks if expressions from this Triple are not equal to elements from list. This syntax is unsupported by SQL Server.

open infix fun List<Column<*>>.notInList(list: Iterable<List<*>>): InListOrNotInListBaseOp<List<*>>

Checks if all columns in this List are not equal to any of the lists of values from list.

@JvmName(name = "notInListCompositeIDs")

open infix fun List<Column<*>>.notInList(list: Iterable<CompositeID>): InListOrNotInListBaseOp<List<*>>

Checks if all columns in this List are not equal to any of the CompositeIDs from list.

@JvmName(name = "notInListIds")

open infix fun <T : Comparable<T>, ID : EntityID<T>?> Column<ID>.notInList(list: Iterable<T>): InListOrNotInListBaseOp<EntityID<T>?>

@JvmName(name = "notInListCompositeEntityIds")

open infix fun <ID : EntityID<CompositeID>> Column<ID>.notInList(list: Iterable<CompositeID>): InListOrNotInListBaseOp<List<*>>

Checks if this EntityID column is not equal to any element from list.

open infix fun <T> ExpressionWithColumnType<T>.notInList(list: Iterable<T>): InListOrNotInListBaseOp<T>

Checks if this expression is not equal to any element from list.

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.

notInTable

open infix fun <T> ExpressionWithColumnType<T>.notInTable(table: Table): InTableOp

Checks if this expression is not equal to any element from the column of table with only a single column.

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.

nthValue

open fun <T> ExpressionWithColumnType<T>.nthValue(n: ExpressionWithColumnType<Int>): NthValue<T>

Returns value evaluated at the row that is the n'th row of the window frame (counting from 1); null if no such row.

ntile

open fun ntile(numBuckets: ExpressionWithColumnType<Int>): Ntile

Returns an integer ranging from 1 to the numBuckets, dividing the partition as equally as possible.

percentRank

open fun percentRank(): PercentRank

Returns the relative rank of the current row, that is (rank - 1) / (total partition rows - 1). The value thus ranges from 0 to 1 inclusive.

plus

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

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.

open infix operator fun <T> ExpressionWithColumnType<T>.plus(t: T): PlusOp<T, T>

Adds the t value to this expression.

open infix operator fun <T, S : T> ExpressionWithColumnType<T>.plus(other: Expression<S>): PlusOp<T, S>

Adds the other expression to this expression.

rank

open fun rank(): Rank

Returns the rank of the current row, with gaps; that is, the row_number of the first row in its peer group.

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

open infix operator fun <T : Number?, S : T> ExpressionWithColumnType<T>.rem(t: S): ModOp<T, S, T>

Calculates the remainder of dividing this expression by the t value.

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

Calculates the remainder of dividing this expression by the other expression.

@JvmName(name = "remWithEntityId")

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

Calculates the remainder of dividing the value of this numeric PK by the other number.

@JvmName(name = "remWithEntityId3")

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

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

@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

rowNumber

open fun rowNumber(): RowNumber

Returns the number of the current row within its partition, counting from 1.

times

open infix operator fun <T> ExpressionWithColumnType<T>.times(t: T): TimesOp<T, T>

Multiplies this expression by the t value.

open infix operator fun <T, S : T> ExpressionWithColumnType<T>.times(other: Expression<S>): TimesOp<T, S>

Multiplies this expression by the other expression.

wrap

open fun <T, S : T?> ExpressionWithColumnType<in S>.wrap(value: T): QueryParameter<T>

Returns the specified value as a query parameter of type T.