Class JoinBuilder<DB, TB>

Type Parameters

DB
TB extends keyof DB

Implements

OperationNodeSource

Index

Constructors

Properties

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 common/temp/node_modules/.pnpm/kysely@0.27.3/node_modules/kysely/dist/cjs/query-builder/join-builder.d.ts:9

Properties

`Private` #private

#private: any

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: this
      Returns T
Returns T
- Defined in common/temp/node_modules/.pnpm/kysely@0.27.3/node_modules/kysely/dist/cjs/query-builder/join-builder.d.ts:33

on

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

See WhereInterface.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 common/temp/node_modules/.pnpm/kysely@0.27.3/node_modules/kysely/dist/cjs/query-builder/join-builder.d.ts:16
on(expression): JoinBuilder<DB, TB>
Parameters
- expression: ExpressionOrFactory<DB, TB, SqlBool>
Returns JoinBuilder<DB, TB>
- Defined in common/temp/node_modules/.pnpm/kysely@0.27.3/node_modules/kysely/dist/cjs/query-builder/join-builder.d.ts:17

onRef

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

See WhereInterface.whereRef for documentation and examples.
Parameters
- lhs: ReferenceExpression<DB, TB>
- op: ComparisonOperatorExpression
- rhs: ReferenceExpression<DB, TB>
Returns JoinBuilder<DB, TB>
- Defined in common/temp/node_modules/.pnpm/kysely@0.27.3/node_modules/kysely/dist/cjs/query-builder/join-builder.d.ts:24

onTrue

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

Returns JoinBuilder<DB, TB>
- Defined in common/temp/node_modules/.pnpm/kysely@0.27.3/node_modules/kysely/dist/cjs/query-builder/join-builder.d.ts:28

toOperationNode

toOperationNode(): kysely.JoinNode
Returns kysely.JoinNode
Implementation of OperationNodeSource.toOperationNode
- Defined in common/temp/node_modules/.pnpm/kysely@0.27.3/node_modules/kysely/dist/cjs/query-builder/join-builder.d.ts:34