kysely 0.10.0 → 0.11.2

package/dist/esm/operation-node/query-node.d.ts

@@ -2,10 +2,10 @@ import { InsertQueryNode } from './insert-query-node.js';
 import { SelectQueryNode } from './select-query-node.js';
 import { UpdateQueryNode } from './update-query-node.js';
 import { DeleteQueryNode } from './delete-query-node.js';
-import { WhereChildNode } from './where-node.js';
 import { JoinNode } from './join-node.js';
 import { SelectionNode } from './selection-node.js';
 import { OperationNode } from './operation-node.js';
+import { FilterExpressionNode } from './operation-node-utils.js';
 export declare type QueryNode = SelectQueryNode | DeleteQueryNode | InsertQueryNode | UpdateQueryNode;
 export declare type MutatingQueryNode = DeleteQueryNode | InsertQueryNode | UpdateQueryNode;
 export declare type FilterableQueryNode = SelectQueryNode | DeleteQueryNode | UpdateQueryNode;
@@ -16,8 +16,8 @@ export declare const QueryNode: Readonly<{
     is(node: OperationNode): node is QueryNode;
     isMutating(node: OperationNode): node is MutatingQueryNode;
     isFilterable(node: OperationNode): node is FilterableQueryNode;
-    cloneWithWhere<T extends FilterableQueryNode>(node: T, filter: WhereChildNode): T;
-    cloneWithOrWhere<T_1 extends FilterableQueryNode>(node: T_1, filter: WhereChildNode): T_1;
+    cloneWithWhere<T extends FilterableQueryNode>(node: T, filter: FilterExpressionNode): T;
+    cloneWithOrWhere<T_1 extends FilterableQueryNode>(node: T_1, filter: FilterExpressionNode): T_1;
     cloneWithJoin<T_2 extends FilterableQueryNode>(node: T_2, join: JoinNode): T_2;
     cloneWithReturning<T_3 extends MutatingQueryNode>(node: T_3, selections: ReadonlyArray<SelectionNode>): T_3;
 }>;

package/dist/esm/operation-node/raw-node.d.ts

@@ -9,6 +9,6 @@ export interface RawNode extends OperationNode {
  */
 export declare const RawNode: Readonly<{
     is(node: OperationNode): node is RawNode;
-    create(sqlFragments: string[], params: ReadonlyArray<OperationNode>): RawNode;
+    create(sqlFragments: ReadonlyArray<string>, params: ReadonlyArray<OperationNode>): RawNode;
     createWithSql(sql: string): RawNode;
 }>;

package/dist/esm/operation-node/select-query-node.d.ts

@@ -1,12 +1,12 @@
 import { FromNode } from './from-node.js';
 import { GroupByItemNode } from './group-by-item-node.js';
 import { GroupByNode } from './group-by-node.js';
-import { HavingNode, HavingNodeChild } from './having-node.js';
+import { HavingNode } from './having-node.js';
 import { JoinNode } from './join-node.js';
 import { LimitNode } from './limit-node.js';
 import { OffsetNode } from './offset-node.js';
 import { OperationNode } from './operation-node.js';
-import { TableExpressionNode } from './operation-node-utils.js';
+import { FilterExpressionNode, TableExpressionNode } from './operation-node-utils.js';
 import { OrderByItemNode } from './order-by-item-node.js';
 import { OrderByNode } from './order-by-node.js';
 import { SelectionNode } from './selection-node.js';
@@ -44,8 +44,8 @@ export declare const SelectQueryNode: Readonly<{
     cloneWithGroupByItems(selectNode: SelectQueryNode, items: ReadonlyArray<GroupByItemNode>): SelectQueryNode;
     cloneWithLimit(selectNode: SelectQueryNode, limit: LimitNode): SelectQueryNode;
     cloneWithOffset(selectNode: SelectQueryNode, offset: OffsetNode): SelectQueryNode;
-    cloneWithHaving(selectNode: SelectQueryNode, filter: HavingNodeChild): SelectQueryNode;
-    cloneWithOrHaving(selectNode: SelectQueryNode, filter: HavingNodeChild): SelectQueryNode;
+    cloneWithHaving(selectNode: SelectQueryNode, filter: FilterExpressionNode): SelectQueryNode;
+    cloneWithOrHaving(selectNode: SelectQueryNode, filter: FilterExpressionNode): SelectQueryNode;
     cloneWithDistinct(selectNode: SelectQueryNode): SelectQueryNode;
     cloneWithUnion(selectNode: SelectQueryNode, union: UnionNode): SelectQueryNode;
 }>;

package/dist/esm/operation-node/where-node.d.ts

@@ -1,18 +1,14 @@
-import { AndNode } from './and-node.js';
-import { FilterNode } from './filter-node.js';
+import { FilterExpressionNode } from './operation-node-utils.js';
 import { OperationNode } from './operation-node.js';
-import { OrNode } from './or-node.js';
-import { ParensNode } from './parens-node.js';
-export declare type WhereChildNode = FilterNode | AndNode | OrNode | ParensNode;
 export interface WhereNode extends OperationNode {
     readonly kind: 'WhereNode';
-    readonly where: WhereChildNode;
+    readonly where: FilterExpressionNode;
 }
 /**
  * @internal
  */
 export declare const WhereNode: Readonly<{
     is(node: OperationNode): node is WhereNode;
-    create(filter: WhereChildNode): WhereNode;
-    cloneWithFilter(whereNode: WhereNode, op: 'And' | 'Or', where: WhereChildNode): WhereNode;
+    create(filter: FilterExpressionNode): WhereNode;
+    cloneWithFilter(whereNode: WhereNode, op: 'And' | 'Or', filter: FilterExpressionNode): WhereNode;
 }>;

package/dist/esm/operation-node/where-node.js

@@ -14,12 +14,12 @@ export const WhereNode = freeze({
             where: filter,
         });
     },
-    cloneWithFilter(whereNode, op, where) {
+    cloneWithFilter(whereNode, op, filter) {
         return freeze({
             ...whereNode,
             where: op === 'And'
-                ? AndNode.create(whereNode.where, where)
-                : OrNode.create(whereNode.where, where),
+                ? AndNode.create(whereNode.where, filter)
+                : OrNode.create(whereNode.where, filter),
         });
     },
 });

package/dist/esm/parser/filter-parser.d.ts

@@ -12,3 +12,4 @@ export declare function parseOnFilter(ctx: ParseContext, args: any[]): FilterExp
 export declare function parseReferenceFilter(ctx: ParseContext, lhs: ReferenceExpression<any, any>, op: FilterOperator, rhs: ReferenceExpression<any, any>): FilterNode;
 export declare function parseExistFilter(ctx: ParseContext, arg: ExistsExpression<any, any>): FilterNode;
 export declare function parseNotExistFilter(ctx: ParseContext, arg: ExistsExpression<any, any>): FilterNode;
+export declare function parseFilter(ctx: ParseContext, type: 'where' | 'having' | 'on', args: any[]): FilterExpressionNode;

package/dist/esm/parser/filter-parser.js

@@ -1,5 +1,5 @@
 import { FilterNode } from '../operation-node/filter-node.js';
-import { isBoolean, isFunction, isNull, isString, } from '../util/object-utils.js';
+import { freeze, isBoolean, isFunction, isNull, isString, } from '../util/object-utils.js';
 import { isOperationNodeSource } from '../operation-node/operation-node-source.js';
 import { RawNode } from '../operation-node/raw-node.js';
 import { OperatorNode, OPERATORS, } from '../operation-node/operator-node.js';
@@ -9,37 +9,13 @@ import { parseValueExpressionOrList, } from './value-parser.js';
 import { SelectQueryNode } from '../operation-node/select-query-node.js';
 import { ValueNode } from '../operation-node/value-node.js';
 export function parseWhereFilter(ctx, args) {
-    if (args.length === 3) {
-        return parseThreeArgFilter(ctx, args[0], args[1], args[2]);
-    }
-    else if (args.length === 1 && isFunction(args[0])) {
-        return parseWhereGroup(ctx, args[0]);
-    }
-    else {
-        throw new Error(`invalid arguments passed to a where method ${JSON.stringify(args)}`);
-    }
+    return parseFilter(ctx, 'where', args);
 }
 export function parseHavingFilter(ctx, args) {
-    if (args.length === 3) {
-        return parseThreeArgFilter(ctx, args[0], args[1], args[2]);
-    }
-    else if (args.length === 1 && isFunction(args[0])) {
-        return parseHavingGroup(ctx, args[0]);
-    }
-    else {
-        throw new Error(`invalid arguments passed to a having method ${JSON.stringify(args)}`);
-    }
+    return parseFilter(ctx, 'having', args);
 }
 export function parseOnFilter(ctx, args) {
-    if (args.length === 3) {
-        return parseThreeArgFilter(ctx, args[0], args[1], args[2]);
-    }
-    else if (args.length === 1 && isFunction(args[0])) {
-        return parseOnGroup(ctx, args[0]);
-    }
-    else {
-        throw new Error(`invalid arguments passed to an on method ${JSON.stringify(args)}`);
-    }
+    return parseFilter(ctx, 'on', args);
 }
 export function parseReferenceFilter(ctx, lhs, op, rhs) {
     return FilterNode.create(parseReferenceExpression(ctx, lhs), parseFilterOperator(op), parseReferenceExpression(ctx, rhs));
@@ -50,6 +26,24 @@ export function parseExistFilter(ctx, arg) {
 export function parseNotExistFilter(ctx, arg) {
     return parseExistExpression(ctx, 'not exists', arg);
 }
+export function parseFilter(ctx, type, args) {
+    if (args.length === 3) {
+        return parseThreeArgFilter(ctx, args[0], args[1], args[2]);
+    }
+    else if (args.length === 1) {
+        const arg = args[0];
+        if (isFunction(arg)) {
+            return GROUP_PARSERS[type](ctx, arg);
+        }
+        else if (isOperationNodeSource(arg)) {
+            const node = arg.toOperationNode();
+            if (RawNode.is(node)) {
+                return node;
+            }
+        }
+    }
+    throw new Error(`invalid arguments passed to a '${type}' method: ${JSON.stringify(args)}`);
+}
 function parseThreeArgFilter(ctx, left, op, right) {
     if ((op === 'is' || op === 'is not') && (isNull(right) || isBoolean(right))) {
         return parseIsFilter(ctx, left, op, right);
@@ -70,30 +64,6 @@ function parseFilterOperator(op) {
     }
     throw new Error(`invalid comparison operator ${JSON.stringify(op)} passed to a filter method`);
 }
-function parseWhereGroup(ctx, callback) {
-    const query = callback(ctx.createSelectQueryBuilder([]));
-    const queryNode = query.toOperationNode();
-    if (!queryNode.where) {
-        throw new Error('no `where*` methods called insided a group callback');
-    }
-    return ParensNode.create(queryNode.where.where);
-}
-function parseHavingGroup(ctx, callback) {
-    const query = callback(ctx.createSelectQueryBuilder([]));
-    const queryNode = query.toOperationNode();
-    if (!queryNode.having) {
-        throw new Error('no `having*` methods called insided a group callback');
-    }
-    return ParensNode.create(queryNode.having.having);
-}
-function parseOnGroup(ctx, callback) {
-    const joinBuilder = callback(ctx.createJoinBuilder('InnerJoin', 'table'));
-    const joinNode = joinBuilder.toOperationNode();
-    if (!joinNode.on) {
-        throw new Error('no `on*` methods called insided a group callback');
-    }
-    return ParensNode.create(joinNode.on);
-}
 function parseExistExpression(ctx, type, arg) {
     const node = isFunction(arg)
         ? arg(ctx.createExpressionBuilder()).toOperationNode()
@@ -103,3 +73,29 @@ function parseExistExpression(ctx, type, arg) {
     }
     return FilterNode.create(undefined, OperatorNode.create(type), node);
 }
+const GROUP_PARSERS = freeze({
+    where(ctx, callback) {
+        const query = callback(ctx.createSelectQueryBuilder([]));
+        const queryNode = query.toOperationNode();
+        if (!queryNode.where) {
+            throw new Error('no `where` methods called insided a group callback');
+        }
+        return ParensNode.create(queryNode.where.where);
+    },
+    having(ctx, callback) {
+        const query = callback(ctx.createSelectQueryBuilder([]));
+        const queryNode = query.toOperationNode();
+        if (!queryNode.having) {
+            throw new Error('no `having` methods called insided a group callback');
+        }
+        return ParensNode.create(queryNode.having.having);
+    },
+    on(ctx, callback) {
+        const joinBuilder = callback(ctx.createJoinBuilder('InnerJoin', 'table'));
+        const joinNode = joinBuilder.toOperationNode();
+        if (!joinNode.on) {
+            throw new Error('no `on` methods called insided a group callback');
+        }
+        return ParensNode.create(joinNode.on.on);
+    },
+});

package/dist/esm/parser/returning-parser.d.ts

@@ -1,7 +1,9 @@
+import { DeleteResult } from '../query-builder/delete-result.js';
+import { InsertResult } from '../query-builder/insert-result.js';
 import { QueryBuilder } from '../query-builder/query-builder.js';
-import { DeleteResultTypeTag, InsertResultTypeTag, UpdateResultTypeTag } from '../util/type-utils.js';
+import { UpdateResult } from '../query-builder/update-result.js';
 import { Selection } from './select-parser.js';
 /**
  * `returning` method output query builder type
  */
-export declare type QueryBuilderWithReturning<DB, TB extends keyof DB, O, S> = QueryBuilder<DB, TB, O extends InsertResultTypeTag ? Selection<DB, TB, S> : O extends DeleteResultTypeTag ? Selection<DB, TB, S> : O extends UpdateResultTypeTag ? Selection<DB, TB, S> : O & Selection<DB, TB, S>>;
+export declare type QueryBuilderWithReturning<DB, TB extends keyof DB, O, S> = QueryBuilder<DB, TB, O extends InsertResult ? Selection<DB, TB, S> : O extends DeleteResult ? Selection<DB, TB, S> : O extends UpdateResult ? Selection<DB, TB, S> : O & Selection<DB, TB, S>>;

package/dist/esm/parser/select-parser.d.ts

@@ -1,7 +1,7 @@
 import { AliasedRawBuilder } from '../raw-builder/raw-builder.js';
 import { AliasedQueryBuilder, QueryBuilder } from '../query-builder/query-builder.js';
 import { SelectionNode } from '../operation-node/selection-node.js';
-import { AliasedQueryBuilderFactory, AliasedRawBuilderFactory, AnyAliasedColumn, AnyAliasedColumnWithTable, AnyAliasedQueryBuilder, AnyAliasedRawBuilder, AnyColumn, AnyColumnWithTable, InsertResultTypeTag, RowType, ValueType } from '../util/type-utils.js';
+import { AliasedQueryBuilderFactory, AliasedRawBuilderFactory, AnyAliasedColumn, AnyAliasedColumnWithTable, AnyAliasedQueryBuilder, AnyAliasedRawBuilder, AnyColumn, AnyColumnWithTable, RowType, ValueType } from '../util/type-utils.js';
 import { DynamicReferenceBuilder } from '../dynamic/dynamic-reference-builder.js';
 import { ParseContext } from './parse-context.js';
 /**
@@ -13,7 +13,7 @@ export declare type SelectExpressionOrList<DB, TB extends keyof DB> = SelectExpr
  * Given a selection expression returns a query builder type that
  * has the selection.
  */
-export declare type QueryBuilderWithSelection<DB, TB extends keyof DB, O, S> = QueryBuilder<DB, TB, O extends InsertResultTypeTag ? InsertResultTypeTag : O & Selection<DB, TB, S>>;
+export declare type QueryBuilderWithSelection<DB, TB extends keyof DB, O, S> = QueryBuilder<DB, TB, O & Selection<DB, TB, S>>;
 /**
  * `selectAll` output query builder type.
  */

package/dist/esm/plugin/immediate-value.ts/immediate-value-plugin.d.ts

@@ -1,6 +1,6 @@
 import { QueryResult } from '../../driver/database-connection.js';
-import { UnknownRow } from '../../index.js';
 import { RootOperationNode } from '../../query-compiler/query-compiler.js';
+import { UnknownRow } from '../../util/type-utils.js';
 import { KyselyPlugin, PluginTransformQueryArgs, PluginTransformResultArgs } from '../kysely-plugin.js';
 /**
  * Transforms all ValueNodes to immediate.

package/dist/esm/query-builder/delete-result.d.ts

@@ -0,0 +1,5 @@
+export declare class DeleteResult {
+    #private;
+    constructor(numDeletedRows: bigint);
+    get numDeletedRows(): bigint;
+}

package/dist/esm/query-builder/delete-result.js

@@ -0,0 +1,9 @@
+export class DeleteResult {
+    #numDeletedRows;
+    constructor(numDeletedRows) {
+        this.#numDeletedRows = numDeletedRows;
+    }
+    get numDeletedRows() {
+        return this.#numDeletedRows;
+    }
+}

package/dist/esm/query-builder/expression-builder.d.ts

@@ -26,7 +26,7 @@ export declare class ExpressionBuilder<DB, TB extends keyof DB> {
      *   .execute()
      * ```
      *
-     * The generated SQL (postgresql):
+     * The generated SQL (PostgreSQL):
      *
      * ```sql
      * select "person"."id", count("pet"."id") as "pet_count"
@@ -62,7 +62,7 @@ export declare class ExpressionBuilder<DB, TB extends keyof DB> {
      * console.log(result[0].owner_name)
      * ```
      *
-     * The generated SQL (postgresql):
+     * The generated SQL (PostgreSQL):
      *
      * ```sql
      * select

package/dist/esm/query-builder/expression-builder.js

@@ -31,7 +31,7 @@ export class ExpressionBuilder {
      *   .execute()
      * ```
      *
-     * The generated SQL (postgresql):
+     * The generated SQL (PostgreSQL):
      *
      * ```sql
      * select "person"."id", count("pet"."id") as "pet_count"

package/dist/esm/query-builder/function-builder.d.ts

@@ -19,7 +19,7 @@ import { RawBuilder } from '../raw-builder/raw-builder.js';
  *   .execute()
  * ```
  *
- * The generated SQL (postgresql):
+ * The generated SQL (PostgreSQL):
  *
  * ```sql
  * select "person"."id", count("pet"."id") as "pet_count"
@@ -66,7 +66,7 @@ export declare class FunctionBuilder<DB, TB extends keyof DB> {
      * Calls the `sum` function for the column given as the argument.
      *
      * If this is used in a `select` statement the type of the selected expression
-     * will be `number | string | BigInt` by default. This is because Kysely can't
+     * will be `number | string | bigint` by default. This is because Kysely can't
      * know the type the db driver outputs. Sometimes the output can be larger than
      * the largest javascript number and a string is returned instead. Most drivers
      * allow you to configure the output type of large numbers and Kysely can't
@@ -83,12 +83,12 @@ export declare class FunctionBuilder<DB, TB extends keyof DB> {
      *   .execute()
      * ```
      */
-    sum<O extends number | string | BigInt, C extends StringReference<DB, TB> = any>(column: C): RawBuilder<O>;
+    sum<O extends number | string | bigint, C extends StringReference<DB, TB> = any>(column: C): RawBuilder<O>;
     /**
      * Calls the `count` function for the column given as the argument.
      *
      * If this is used in a `select` statement the type of the selected expression
-     * will be `number | string | BigInt` by default. This is because Kysely can't
+     * will be `number | string |bigint` by default. This is because Kysely can't
      * know the type the db driver outputs. Sometimes the output can be larger than
      * the largest javascript number and a string is returned instead. Most drivers
      * allow you to configure the output type of large numbers and Kysely can't
@@ -105,7 +105,7 @@ export declare class FunctionBuilder<DB, TB extends keyof DB> {
      *   .execute()
      * ```
      */
-    count<O extends number | string | BigInt, C extends StringReference<DB, TB> = any>(column: C): RawBuilder<O>;
+    count<O extends number | string | bigint, C extends StringReference<DB, TB> = any>(column: C): RawBuilder<O>;
 }
 export interface FunctionBuilderProps {
     readonly executor: QueryExecutor;

package/dist/esm/query-builder/function-builder.js

@@ -19,7 +19,7 @@ import { createQueryId } from '../util/query-id.js';
  *   .execute()
  * ```
  *
- * The generated SQL (postgresql):
+ * The generated SQL (PostgreSQL):
  *
  * ```sql
  * select "person"."id", count("pet"."id") as "pet_count"
@@ -79,7 +79,7 @@ export class FunctionBuilder {
      * Calls the `sum` function for the column given as the argument.
      *
      * If this is used in a `select` statement the type of the selected expression
-     * will be `number | string | BigInt` by default. This is because Kysely can't
+     * will be `number | string | bigint` by default. This is because Kysely can't
      * know the type the db driver outputs. Sometimes the output can be larger than
      * the largest javascript number and a string is returned instead. Most drivers
      * allow you to configure the output type of large numbers and Kysely can't
@@ -103,7 +103,7 @@ export class FunctionBuilder {
      * Calls the `count` function for the column given as the argument.
      *
      * If this is used in a `select` statement the type of the selected expression
-     * will be `number | string | BigInt` by default. This is because Kysely can't
+     * will be `number | string |bigint` by default. This is because Kysely can't
      * know the type the db driver outputs. Sometimes the output can be larger than
      * the largest javascript number and a string is returned instead. Most drivers
      * allow you to configure the output type of large numbers and Kysely can't

package/dist/esm/query-builder/insert-result.d.ts

@@ -0,0 +1,27 @@
+/**
+ * The result of an insert query.
+ *
+ * If the table has an auto incrementing primary key {@link insertId} will hold
+ * the generated id on dialects that support it. For example PostgreSQL doesn't
+ * return the id by default and {@link insertId} is undefined. On PostgreSQL you
+ * need to use {@link QueryBuilder.returning} or {@link QueryBuilder.returningAll}
+ * to get out the inserted id.
+ *
+ * @example
+ * ```ts
+ * const result = await db
+ *   .insertInto('person')
+ *   .values(person)
+ *   .executeTakeFirst()
+ *
+ * console.log(result.insertId)
+ * ```
+ */
+export declare class InsertResult {
+    #private;
+    constructor(insertId: bigint | undefined);
+    /**
+     * The auto incrementing primary key
+     */
+    get insertId(): bigint | undefined;
+}

package/dist/esm/query-builder/insert-result.js

@@ -0,0 +1,31 @@
+/**
+ * The result of an insert query.
+ *
+ * If the table has an auto incrementing primary key {@link insertId} will hold
+ * the generated id on dialects that support it. For example PostgreSQL doesn't
+ * return the id by default and {@link insertId} is undefined. On PostgreSQL you
+ * need to use {@link QueryBuilder.returning} or {@link QueryBuilder.returningAll}
+ * to get out the inserted id.
+ *
+ * @example
+ * ```ts
+ * const result = await db
+ *   .insertInto('person')
+ *   .values(person)
+ *   .executeTakeFirst()
+ *
+ * console.log(result.insertId)
+ * ```
+ */
+export class InsertResult {
+    #insertId;
+    constructor(insertId) {
+        this.#insertId = insertId;
+    }
+    /**
+     * The auto incrementing primary key
+     */
+    get insertId() {
+        return this.#insertId;
+    }
+}

package/dist/esm/query-builder/join-builder.d.ts

@@ -4,6 +4,7 @@ import { ExistsExpression, FilterOperator } from '../parser/filter-parser.js';
 import { ParseContext } from '../parser/parse-context.js';
 import { ReferenceExpression } from '../parser/reference-parser.js';
 import { ValueExpressionOrList } from '../parser/value-parser.js';
+import { AnyRawBuilder } from '../util/type-utils.js';
 export declare class JoinBuilder<DB, TB extends keyof DB> implements OperationNodeSource {
     #private;
     constructor(props: JoinBuilderProps);
@@ -15,6 +16,7 @@ export declare class JoinBuilder<DB, TB extends keyof DB> implements OperationNo
      */
     on<RE extends ReferenceExpression<DB, TB>>(lhs: RE, op: FilterOperator, rhs: ValueExpressionOrList<DB, TB, RE>): JoinBuilder<DB, TB>;
     on(grouper: (qb: JoinBuilder<DB, TB>) => JoinBuilder<DB, TB>): JoinBuilder<DB, TB>;
+    on(raw: AnyRawBuilder): JoinBuilder<DB, TB>;
     /**
      * Just like {@link QueryBuilder.orWhere} but adds an item to the join's
      * `on` clause instead.
@@ -23,6 +25,7 @@ export declare class JoinBuilder<DB, TB extends keyof DB> implements OperationNo
      */
     orOn<RE extends ReferenceExpression<DB, TB>>(lhs: RE, op: FilterOperator, rhs: ValueExpressionOrList<DB, TB, RE>): JoinBuilder<DB, TB>;
     orOn(grouper: (qb: JoinBuilder<DB, TB>) => JoinBuilder<DB, TB>): JoinBuilder<DB, TB>;
+    orOn(raw: AnyRawBuilder): JoinBuilder<DB, TB>;
     /**
      * Just like {@link QueryBuilder.whereRef} but adds an item to the join's
      * `on` clause instead.