Last Updated: 3/9/2026

kysely

• JoinBuilder

Class JoinBuilder

Type Parameters

• DB
• TB extends keyof DB

Implements

• OperationNodeSource

Index

Constructors

constructor

Methods

$call on onRef onTrue toOperationNode

Constructors

constructor

• new JoinBuilder<DB, TB extends string | number | symbol>(
      props: JoinBuilderProps,
  ): JoinBuilder<DB, TB>

  Type Parameters

  • DB
  • TB extends string | number | symbol

  Parameters

  • props: JoinBuilderProps

  Returns JoinBuilder<DB, TB>

Methods

$call

• $call<T>(func: (qb: this) => T): 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: this) => T

  Returns T

on

• on<
      RE extends
          | string
          | Expression
          | DynamicReferenceBuilder
          | SelectQueryBuilderExpression<Record<string, any>>
          | OperandExpressionFactory<DB, TB, any>,

  (
      lhs: RE,
      op: ComparisonOperatorExpression,
      rhs: OperandValueExpressionOrList<DB, TB, RE>,
  ): 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
        | DynamicReferenceBuilder
        | SelectQueryBuilderExpression<Record<string, any>>
        | OperandExpressionFactory<DB, TB, any>

  Parameters

  • lhs: RE
  • op: ComparisonOperatorExpression
  • rhs: OperandValueExpressionOrList<DB, TB, RE>

  Returns JoinBuilder<DB, TB>

• on(expression: ExpressionOrFactory<DB, TB, SqlBool>): 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.

  Parameters

  • expression: ExpressionOrFactory<DB, TB, SqlBool>

  Returns JoinBuilder<DB, TB>

onRef

• onRef(
      lhs: ReferenceExpression<DB, TB>,
      op: ComparisonOperatorExpression,
      rhs: ReferenceExpression<DB, TB>,
  ): 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>

onTrue

• onTrue(): JoinBuilder<DB, TB>

  Adds on true.

  Returns JoinBuilder<DB, TB>

toOperationNode

• toOperationNode(): JoinNode

  Returns JoinNode

Settings

Member Visibility

On This Page

Constructors

constructor

Methods

$callononRefonTruetoOperationNode