ktorm-core/org.ktorm.schema/Column

Column

data class Column<T : Any>(val table: BaseTable<*>, val name: String, val binding: ColumnBinding? = null, val extraBindings: List<ColumnBinding> = emptyList(), val sqlType: SqlType<T>) : ColumnDeclaring<T> (source)

Represents database columns.

Constructors

Column

constructor(table: BaseTable<*>, name: String, binding: ColumnBinding? = null, extraBindings: List<ColumnBinding> = emptyList(), sqlType: SqlType<T>)

Properties

allBindings

val allBindings: List<ColumnBinding>

Return all the bindings of this column, including the primary binding and extraBindings.

binding

val binding: ColumnBinding? = null

The column's primary binding. A column might be bound to a simple property, nested properties, or a reference to another table, null if the column doesn't bind to any property.

extraBindings

val extraBindings: List<ColumnBinding>

The column's extra bindings. Useful when we need to configure two or more bindings for a column.

label

val label: String

The column's label, used to identify the selected columns and to obtain query results.

name

val name: String

The column's name.

referenceTable

val referenceTable: BaseTable<*>?

If the column is bound to a reference table, return the table, otherwise return null.

sqlType

open override val sqlType: SqlType<T>

The SqlType of this column or expression.

table

val table: BaseTable<*>

The table that this column belongs to.

Functions

aliased

open override fun aliased(label: String?): ColumnDeclaringExpression<T>

Wrap this column as a ColumnDeclaringExpression.

and

infix fun ColumnDeclaring<Boolean>.and(value: Boolean): BinaryExpression<Boolean>

infix fun ColumnDeclaring<Boolean>.and(expr: ColumnDeclaring<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.

asExpression

open override fun asExpression(): ColumnExpression<T>

Convert this column to a ColumnExpression.

between

infix fun <T : Comparable<T>> ColumnDeclaring<T>.between(range: ClosedRange<T>): BetweenExpression

Between operator, translated to between .. and .. in SQL.

cast

fun <T : Any> ColumnDeclaring<*>.cast(sqlType: SqlType<T>): CastingExpression<T>

Cast the current column or expression to the given SqlType.

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(value: T): BinaryExpression<T>

infix operator fun <T : Number> ColumnDeclaring<T>.div(expr: ColumnDeclaring<T>): BinaryExpression<T>

Divide operator, translated to / in SQL.

infix fun <T : Any> ColumnDeclaring<T>.eq(value: T): BinaryExpression<Boolean>

infix fun <T : Any> ColumnDeclaring<T>.eq(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Equal operator, translated to = in SQL.

equals

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

Indicates whether some other object is "equal to" this column. Two columns are equal only if they are the same instance.

greater

infix fun <T : Comparable<T>> ColumnDeclaring<T>.greater(value: T): BinaryExpression<Boolean>

infix fun <T : Comparable<T>> ColumnDeclaring<T>.greater(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Greater operator, translated to > in SQL.

greaterEq

infix fun <T : Comparable<T>> ColumnDeclaring<T>.greaterEq(value: T): BinaryExpression<Boolean>

infix fun <T : Comparable<T>> ColumnDeclaring<T>.greaterEq(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Greater-eq operator, translated to >= in SQL.

infix fun <T : Comparable<T>> ColumnDeclaring<T>.gt(value: T): BinaryExpression<Boolean>

infix fun <T : Comparable<T>> ColumnDeclaring<T>.gt(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Greater operator, translated to > in SQL.

gte

infix fun <T : Comparable<T>> ColumnDeclaring<T>.gte(value: T): BinaryExpression<Boolean>

infix fun <T : Comparable<T>> ColumnDeclaring<T>.gte(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Greater-eq operator, translated to >= in SQL.

hashCode

open override fun hashCode(): Int

Return a hash code value for this column.

inList

infix fun ColumnDeclaring<*>.inList(query: Query): InListExpression

fun <T : Any> ColumnDeclaring<T>.inList(vararg list: T): InListExpression

infix fun <T : Any> ColumnDeclaring<T>.inList(list: Collection<T>): InListExpression

In-list operator, translated to the in keyword in SQL.

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.

less

infix fun <T : Comparable<T>> ColumnDeclaring<T>.less(value: T): BinaryExpression<Boolean>

infix fun <T : Comparable<T>> ColumnDeclaring<T>.less(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Less operator, translated to < in SQL.

lessEq

infix fun <T : Comparable<T>> ColumnDeclaring<T>.lessEq(value: T): BinaryExpression<Boolean>

infix fun <T : Comparable<T>> ColumnDeclaring<T>.lessEq(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Less-eq operator, translated to <= in SQL.

infix fun ColumnDeclaring<*>.like(value: String): BinaryExpression<Boolean>

infix fun ColumnDeclaring<*>.like(expr: ColumnDeclaring<String>): BinaryExpression<Boolean>

Like operator, translated to the like keyword in SQL.

infix fun <T : Comparable<T>> ColumnDeclaring<T>.lt(value: T): BinaryExpression<Boolean>

infix fun <T : Comparable<T>> ColumnDeclaring<T>.lt(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Less operator, translated to < in SQL.

lte

infix fun <T : Comparable<T>> ColumnDeclaring<T>.lte(value: T): BinaryExpression<Boolean>

infix fun <T : Comparable<T>> ColumnDeclaring<T>.lte(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Less-eq operator, translated to <= in SQL.

minus

infix operator fun <T : Number> ColumnDeclaring<T>.minus(value: T): BinaryExpression<T>

infix operator fun <T : Number> ColumnDeclaring<T>.minus(expr: ColumnDeclaring<T>): BinaryExpression<T>

Minus operator, translated to - in SQL.

neq

infix fun <T : Any> ColumnDeclaring<T>.neq(value: T): BinaryExpression<Boolean>

infix fun <T : Any> ColumnDeclaring<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.

notBetween

infix fun <T : Comparable<T>> ColumnDeclaring<T>.notBetween(range: ClosedRange<T>): BetweenExpression

Not-between operator, translated to not between .. and .. in SQL.

notEq

infix fun <T : Any> ColumnDeclaring<T>.notEq(value: T): BinaryExpression<Boolean>

infix fun <T : Any> ColumnDeclaring<T>.notEq(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Not-equal operator, translated to <> in SQL.

notInList

infix fun ColumnDeclaring<*>.notInList(query: Query): InListExpression

fun <T : Any> ColumnDeclaring<T>.notInList(vararg list: T): InListExpression

infix fun <T : Any> ColumnDeclaring<T>.notInList(list: Collection<T>): InListExpression

Not-in-list operator, translated to the not in keyword in SQL.

notLike

infix fun ColumnDeclaring<*>.notLike(value: String): BinaryExpression<Boolean>

infix fun ColumnDeclaring<*>.notLike(expr: ColumnDeclaring<String>): BinaryExpression<Boolean>

Not like operator, translated to the not like keyword in SQL.

infix fun ColumnDeclaring<Boolean>.or(value: Boolean): BinaryExpression<Boolean>

infix fun ColumnDeclaring<Boolean>.or(expr: ColumnDeclaring<Boolean>): BinaryExpression<Boolean>

Or operator, translated to the or keyword in SQL.

plus

infix operator fun <T : Number> ColumnDeclaring<T>.plus(value: T): BinaryExpression<T>

infix operator fun <T : Number> ColumnDeclaring<T>.plus(expr: ColumnDeclaring<T>): BinaryExpression<T>

Plus operator, translated to + in SQL.

rem

infix operator fun <T : Number> ColumnDeclaring<T>.rem(value: T): BinaryExpression<T>

infix operator fun <T : Number> ColumnDeclaring<T>.rem(expr: ColumnDeclaring<T>): BinaryExpression<T>

Mod operator, translated to % in SQL.

times

infix operator fun <T : Number> ColumnDeclaring<T>.times(value: T): BinaryExpression<T>

infix operator fun <T : Number> ColumnDeclaring<T>.times(expr: ColumnDeclaring<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.

toInt

@JvmName(name = "booleanToInt")

fun ColumnDeclaring<Boolean>.~~toInt~~(): CastingExpression<Int>

fun ColumnDeclaring<out Number>.toInt(): CastingExpression<Int>

Cast the current column or expression's type to Int.

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.

toString

open override fun toString(): String

Return a string representation of this column.

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.

wrapArgument

open override fun wrapArgument(argument: T?): ArgumentExpression<T>

Wrap the given argument as an ArgumentExpression using the sqlType.

xor

infix fun ColumnDeclaring<Boolean>.xor(value: Boolean): BinaryExpression<Boolean>

infix fun ColumnDeclaring<Boolean>.xor(expr: ColumnDeclaring<Boolean>): BinaryExpression<Boolean>

Xor operator, translated to the xor keyword in SQL.