Class JoinBuilder<DB, TB>

Type Parameters

DB
TB extends keyof DB

Hierarchy

JoinBuilder

Implements

OperationNodeSource

Index

Constructors

Methods

$call on onRef onTrue toOperationNode

Constructors

constructor

new JoinBuilder<DB, TB>(props): JoinBuilder<DB, TB>
Type Parameters
- DB
- TB extends string | number | symbol
Parameters
- props: JoinBuilderProps
Returns JoinBuilder<DB, TB>
- Defined in kysely/src/query-builder/join-builder.ts:21

Methods

$call

$call<T>(func): T
Simply calls the provided function passing this as the only argument. $call returns what the provided function returns.
Type Parameters
- T
Parameters
- func: ((qb) => T)
  - - (qb): T
    - Parameters
      
      qb: JoinBuilder<DB, TB>
      
      Returns T
Returns T
- Defined in kysely/src/query-builder/join-builder.ts:86

on

on<RE>(lhs, op, rhs): JoinBuilder<DB, TB>
Just like where but adds an item to the join's on clause instead.

See where for documentation and examples.
Type Parameters
- RE extends string | Expression<any> | DynamicReferenceBuilder<any> | SelectQueryBuilderExpression<Record<string, any>> | OperandExpressionFactory<DB, TB, any>
Parameters
- lhs: RE
- op: ComparisonOperatorExpression
- rhs: OperandValueExpressionOrList<DB, TB, RE>
Returns JoinBuilder<DB, TB>
- Defined in kysely/src/query-builder/join-builder.ts:31
on(expression): JoinBuilder<DB, TB>
Parameters
- expression: ExpressionOrFactory<DB, TB, SqlBool>
Returns JoinBuilder<DB, TB>
- Defined in kysely/src/query-builder/join-builder.ts:37

onRef

onRef(lhs, op, rhs): JoinBuilder<DB, TB>
Just like whereRef but adds an item to the join's on clause instead.

See whereRef for documentation and examples.
Parameters
- lhs: ReferenceExpression<DB, TB>
- op: ComparisonOperatorExpression
- rhs: ReferenceExpression<DB, TB>
Returns JoinBuilder<DB, TB>
- Defined in kysely/src/query-builder/join-builder.ts:55

onTrue

onTrue(): JoinBuilder<DB, TB>
Adds on true.

Returns JoinBuilder<DB, TB>
- Defined in kysely/src/query-builder/join-builder.ts:72

toOperationNode

toOperationNode(): JoinNode
Returns JoinNode
Implementation of OperationNodeSource.toOperationNode
- Defined in kysely/src/query-builder/join-builder.ts:90

Generated using TypeDoc