English | 简体中文

api-docs / org.ktorm.expression / JoinExpression

JoinExpression

data class JoinExpression : QuerySourceExpression (source code)

Join expression.

Constructors

NameSummary

<init>

JoinExpression(
    type: JoinType,
    left: QuerySourceExpression,
    right: QuerySourceExpression,
    condition: ScalarExpression<Boolean>? = null,
    isLeafNode: Boolean = false,
    extraProperties: Map<String, Any> = emptyMap())

Join expression.

Properties

NameSummary

condition

val condition: ScalarExpression<Boolean>?

the joining condition.

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.

left

the left table.

right

the right table.

type

val type: JoinType

the expression’s type.

Extension Functions

NameSummary

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.