kysely 0.23.5 → 0.24.0

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

@@ -1,17 +1,16 @@
 /// <reference types="./delete-query-builder.d.ts" />
 import { parseJoin, } from '../parser/join-parser.js';
 import { parseTableExpressionOrList, } from '../parser/table-parser.js';
-import { parseSelectExpressionOrList, parseSelectAll, } from '../parser/select-parser.js';
+import { parseSelectArg, parseSelectAll, } from '../parser/select-parser.js';
 import { QueryNode } from '../operation-node/query-node.js';
 import { preventAwait } from '../util/prevent-await.js';
 import { freeze } from '../util/object-utils.js';
-import { NoResultError } from './no-result-error.js';
+import { isNoResultErrorConstructor, NoResultError, } from './no-result-error.js';
 import { DeleteResult } from './delete-result.js';
 import { DeleteQueryNode } from '../operation-node/delete-query-node.js';
 import { LimitNode } from '../operation-node/limit-node.js';
 import { parseOrderBy, } from '../parser/order-by-parser.js';
-import { ExplainNode } from '../operation-node/explain-node.js';
-import { parseReferentialFilter, parseWhere, } from '../parser/binary-operation-parser.js';
+import { parseReferentialComparison, parseWhere, } from '../parser/binary-operation-parser.js';
 import { parseExists, parseNotExists, } from '../parser/unary-operation-parser.js';
 export class DeleteQueryBuilder {
     #props;
@@ -27,7 +26,7 @@ export class DeleteQueryBuilder {
     whereRef(lhs, op, rhs) {
         return new DeleteQueryBuilder({
             ...this.#props,
-            queryNode: QueryNode.cloneWithWhere(this.#props.queryNode, parseReferentialFilter(lhs, op, rhs)),
+            queryNode: QueryNode.cloneWithWhere(this.#props.queryNode, parseReferentialComparison(lhs, op, rhs)),
         });
     }
     orWhere(...args) {
@@ -39,7 +38,7 @@ export class DeleteQueryBuilder {
     orWhereRef(lhs, op, rhs) {
         return new DeleteQueryBuilder({
             ...this.#props,
-            queryNode: QueryNode.cloneWithOrWhere(this.#props.queryNode, parseReferentialFilter(lhs, op, rhs)),
+            queryNode: QueryNode.cloneWithOrWhere(this.#props.queryNode, parseReferentialComparison(lhs, op, rhs)),
         });
     }
     whereExists(arg) {
@@ -105,13 +104,13 @@ export class DeleteQueryBuilder {
     returning(selection) {
         return new DeleteQueryBuilder({
             ...this.#props,
-            queryNode: QueryNode.cloneWithReturning(this.#props.queryNode, parseSelectExpressionOrList(selection)),
+            queryNode: QueryNode.cloneWithReturning(this.#props.queryNode, parseSelectArg(selection)),
         });
     }
-    returningAll() {
+    returningAll(table) {
         return new DeleteQueryBuilder({
             ...this.#props,
-            queryNode: QueryNode.cloneWithReturning(this.#props.queryNode, parseSelectAll()),
+            queryNode: QueryNode.cloneWithReturning(this.#props.queryNode, parseSelectAll(table)),
         });
     }
     /**
@@ -179,7 +178,8 @@ export class DeleteQueryBuilder {
         });
     }
     /**
-     * Simply calls the given function passing `this` as the only argument.
+     * Simply calls the provided function passing `this` as the only argument. `$call` returns
+     * what the provided function returns.
      *
      * If you want to conditionally call a method on `this`, see
      * the {@link $if} method.
@@ -352,7 +352,7 @@ export class DeleteQueryBuilder {
         return [
             new DeleteResult(
             // TODO: remove numUpdatedOrDeletedRows.
-            result.numAffectedRows ?? result.numUpdatedOrDeletedRows ?? 0n),
+            result.numAffectedRows ?? result.numUpdatedOrDeletedRows ?? BigInt(0)),
         ];
     }
     /**
@@ -368,36 +368,30 @@ export class DeleteQueryBuilder {
      * the query returned no result.
      *
      * By default an instance of {@link NoResultError} is thrown, but you can
-     * provide a custom error class as the only argument to throw a different
+     * provide a custom error class, or callback as the only argument to throw a different
      * error.
      */
     async executeTakeFirstOrThrow(errorConstructor = NoResultError) {
         const result = await this.executeTakeFirst();
         if (result === undefined) {
-            throw new errorConstructor(this.toOperationNode());
+            const error = isNoResultErrorConstructor(errorConstructor)
+                ? new errorConstructor(this.toOperationNode())
+                : errorConstructor(this.toOperationNode());
+            throw error;
         }
         return result;
     }
-    /**
-     * Executes query with `explain` statement before `delete` keyword.
-     *
-     * ```ts
-     * const explained = await db
-     *  .deleteFrom('person')
-     *  .where('id', '=', 123)
-     *  .explain('json')
-     * ```
-     *
-     * The generated SQL (MySQL):
-     *
-     * ```sql
-     * explain format=json delete from `person` where `id` = ?
-     * ```
-     */
+    async *stream(chunkSize = 100) {
+        const compiledQuery = this.compile();
+        const stream = this.#props.executor.stream(compiledQuery, chunkSize, this.#props.queryId);
+        for await (const item of stream) {
+            yield* item.rows;
+        }
+    }
     async explain(format, options) {
         const builder = new DeleteQueryBuilder({
             ...this.#props,
-            queryNode: DeleteQueryNode.cloneWithExplain(this.#props.queryNode, ExplainNode.create(format, options?.toOperationNode())),
+            queryNode: QueryNode.cloneWithExplain(this.#props.queryNode, format, options),
         });
         return await builder.execute();
     }

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

@@ -8,3 +8,6 @@ export class DeleteResult {
         return this.#numDeletedRows;
     }
 }
+Object.defineProperty(DeleteResult.prototype, 'numDeletedRows', {
+    enumerable: true,
+});

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

@@ -0,0 +1,62 @@
+import { Expression } from '../expression/expression.js';
+import { OperationNode } from '../operation-node/operation-node.js';
+import { ComparisonOperatorExpression, OperandValueExpressionOrList } from '../parser/binary-operation-parser.js';
+import { ReferenceExpression } from '../parser/reference-parser.js';
+import { ExistsExpression } from '../parser/unary-operation-parser.js';
+import { ExpressionBuilder } from '../expression/expression-builder.js';
+/**
+ * Temporary transitional wrapper type that contains the old `HavingGrouper` methods
+ * and the new `ExpressionBuilder` interface. One we remove the deprecated methods,
+ * this interface can be ditched in favor of just `ExpressionBuilder`.
+ */
+export interface HavingExpressionBuilder<DB, TB extends keyof DB> extends ExpressionBuilder<DB, TB> {
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    having<RE extends ReferenceExpression<DB, TB>>(lhs: RE, op: ComparisonOperatorExpression, rhs: OperandValueExpressionOrList<DB, TB, RE>): HavingExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    having(grouper: HavingExpressionBuilder<DB, TB>): HavingExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    having(expression: Expression<any>): HavingExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    havingRef(lhs: ReferenceExpression<DB, TB>, op: ComparisonOperatorExpression, rhs: ReferenceExpression<DB, TB>): HavingExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    orHaving<RE extends ReferenceExpression<DB, TB>>(lhs: RE, op: ComparisonOperatorExpression, rhs: OperandValueExpressionOrList<DB, TB, RE>): HavingExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    orHaving(grouper: HavingExpressionBuilder<DB, TB>): HavingExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    orHaving(expression: Expression<any>): HavingExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    orHavingRef(lhs: ReferenceExpression<DB, TB>, op: ComparisonOperatorExpression, rhs: ReferenceExpression<DB, TB>): HavingExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    havingExists(arg: ExistsExpression<DB, TB>): HavingExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    havingNotExists(arg: ExistsExpression<DB, TB>): HavingExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    orHavingExists(arg: ExistsExpression<DB, TB>): HavingExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    orHavingNotExists(arg: ExistsExpression<DB, TB>): HavingExpressionBuilder<DB, TB>;
+    toOperationNode(): OperationNode;
+}

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

@@ -0,0 +1,2 @@
+/// <reference types="./deprecated-having-expression-builder.d.ts" />
+export {};

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

@@ -0,0 +1,62 @@
+import { Expression } from '../expression/expression.js';
+import { OperationNode } from '../operation-node/operation-node.js';
+import { ComparisonOperatorExpression, OperandValueExpressionOrList } from '../parser/binary-operation-parser.js';
+import { ReferenceExpression } from '../parser/reference-parser.js';
+import { ExistsExpression } from '../parser/unary-operation-parser.js';
+import { ExpressionBuilder } from '../expression/expression-builder.js';
+/**
+ * Temporary transitional wrapper type that contains the old `OnGrouper` methods
+ * and the new `ExpressionBuilder` interface. One we remove the deprecated methods,
+ * this interface can be ditched in favor of just `ExpressionBuilder`.
+ */
+export interface OnExpressionBuilder<DB, TB extends keyof DB> extends ExpressionBuilder<DB, TB> {
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    on<RE extends ReferenceExpression<DB, TB>>(lhs: RE, op: ComparisonOperatorExpression, rhs: OperandValueExpressionOrList<DB, TB, RE>): OnExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    on(grouper: OnExpressionBuilder<DB, TB>): OnExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    on(expression: Expression<any>): OnExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    onRef(lhs: ReferenceExpression<DB, TB>, op: ComparisonOperatorExpression, rhs: ReferenceExpression<DB, TB>): OnExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    orOn<RE extends ReferenceExpression<DB, TB>>(lhs: RE, op: ComparisonOperatorExpression, rhs: OperandValueExpressionOrList<DB, TB, RE>): OnExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    orOn(grouper: OnExpressionBuilder<DB, TB>): OnExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    orOn(expression: Expression<any>): OnExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    orOnRef(lhs: ReferenceExpression<DB, TB>, op: ComparisonOperatorExpression, rhs: ReferenceExpression<DB, TB>): OnExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    onExists(arg: ExistsExpression<DB, TB>): OnExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    onNotExists(arg: ExistsExpression<DB, TB>): OnExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    orOnExists(arg: ExistsExpression<DB, TB>): OnExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    orOnNotExists(arg: ExistsExpression<DB, TB>): OnExpressionBuilder<DB, TB>;
+    toOperationNode(): OperationNode;
+}

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

@@ -0,0 +1,2 @@
+/// <reference types="./deprecated-on-expression-builder.d.ts" />
+export {};

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

@@ -0,0 +1,62 @@
+import { Expression } from '../expression/expression.js';
+import { OperationNode } from '../operation-node/operation-node.js';
+import { ComparisonOperatorExpression, OperandValueExpressionOrList } from '../parser/binary-operation-parser.js';
+import { ReferenceExpression } from '../parser/reference-parser.js';
+import { ExistsExpression } from '../parser/unary-operation-parser.js';
+import { ExpressionBuilder } from '../expression/expression-builder.js';
+/**
+ * Temporary transitional wrapper type that contains the old `WhereGrouper` methods
+ * and the new `ExpressionBuilder` interface. One we remove the deprecated methods,
+ * this interface can be ditched in favor of just `ExpressionBuilder`.
+ */
+export interface WhereExpressionBuilder<DB, TB extends keyof DB> extends ExpressionBuilder<DB, TB> {
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    where<RE extends ReferenceExpression<DB, TB>>(lhs: RE, op: ComparisonOperatorExpression, rhs: OperandValueExpressionOrList<DB, TB, RE>): WhereExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    where(grouper: WhereExpressionBuilder<DB, TB>): WhereExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    where(expression: Expression<any>): WhereExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    whereRef(lhs: ReferenceExpression<DB, TB>, op: ComparisonOperatorExpression, rhs: ReferenceExpression<DB, TB>): WhereExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    orWhere<RE extends ReferenceExpression<DB, TB>>(lhs: RE, op: ComparisonOperatorExpression, rhs: OperandValueExpressionOrList<DB, TB, RE>): WhereExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    orWhere(grouper: WhereExpressionBuilder<DB, TB>): WhereExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    orWhere(expression: Expression<any>): WhereExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    orWhereRef(lhs: ReferenceExpression<DB, TB>, op: ComparisonOperatorExpression, rhs: ReferenceExpression<DB, TB>): WhereExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    whereExists(arg: ExistsExpression<DB, TB>): WhereExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    whereNotExists(arg: ExistsExpression<DB, TB>): WhereExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    orWhereExists(arg: ExistsExpression<DB, TB>): WhereExpressionBuilder<DB, TB>;
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
+    orWhereNotExists(arg: ExistsExpression<DB, TB>): WhereExpressionBuilder<DB, TB>;
+    toOperationNode(): OperationNode;
+}

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

@@ -0,0 +1,2 @@
+/// <reference types="./deprecated-where-expression-builder.d.ts" />
+export {};

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

@@ -1,7 +1,7 @@
 import { DynamicReferenceBuilder } from '../dynamic/dynamic-reference-builder.js';
+import { ExpressionWrapper } from '../expression/expression-wrapper.js';
 import { CoalesceReferenceExpressionList } from '../parser/coalesce-parser.js';
 import { ExtractTypeFromReferenceExpression, SimpleReferenceExpression, ReferenceExpression, StringReference } from '../parser/reference-parser.js';
-import { RawBuilder } from '../raw-builder/raw-builder.js';
 import { Equals, IsNever } from '../util/type-utils.js';
 import { AggregateFunctionBuilder } from './aggregate-function-builder.js';
 /**
@@ -36,8 +36,35 @@ import { AggregateFunctionBuilder } from './aggregate-function-builder.js';
  * having count("pet"."id") > $1
  * ```
  */
-export declare class FunctionModule<DB, TB extends keyof DB> {
-    constructor();
+export interface FunctionModule<DB, TB extends keyof DB> {
+    /**
+     * Creates a function call.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .selectAll('person')
+     *   .where(db.fn('upper', ['first_name']), '=', 'JENNIFER')
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * select "person".*
+     * from "person"
+     * where upper("first_name") = $1
+     * ```
+     *
+     * If you prefer readability over type-safety, you can always use raw `sql`:
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .selectAll('person')
+     *   .where(sql`upper(first_name)`, '=', 'JENNIFER')
+     * ```
+     */
+    <T>(name: string, args: ReadonlyArray<ReferenceExpression<DB, TB>>): ExpressionWrapper<T>;
     /**
      * Calls the `avg` function for the column given as the argument.
      *
@@ -67,7 +94,7 @@ export declare class FunctionModule<DB, TB extends keyof DB> {
      *
      * ```ts
      * db.selectFrom('toy')
-     *   .select(qb => qb.fn.avg('price').as('avg_price'))
+     *   .select((eb) => eb.fn.avg('price').as('avg_price'))
      *   .execute()
      * ```
      *
@@ -143,8 +170,8 @@ export declare class FunctionModule<DB, TB extends keyof DB> {
      *
      * ```ts
      * db.selectFrom('participant')
-     *   .select(qb =>
-     *     qb.fn.coalesce('nickname', sql<string>`'<anonymous>'`).as('nickname')
+     *   .select((eb) =>
+     *     eb.fn.coalesce('nickname', sql<string>`'<anonymous>'`).as('nickname')
      *   )
      *   .where('room_id', '=', roomId)
      *   .execute()
@@ -167,7 +194,7 @@ export declare class FunctionModule<DB, TB extends keyof DB> {
      * select coalesce(avg("age"), 0) as "avg_age" from "person" where "first_name" = $1
      * ```
      */
-    coalesce<V extends ReferenceExpression<DB, TB>, OV extends ReferenceExpression<DB, TB>[]>(value: V, ...otherValues: OV): RawBuilder<CoalesceReferenceExpressionList<DB, TB, [V, ...OV]>>;
+    coalesce<V extends ReferenceExpression<DB, TB>, OV extends ReferenceExpression<DB, TB>[]>(value: V, ...otherValues: OV): ExpressionWrapper<CoalesceReferenceExpressionList<DB, TB, [V, ...OV]>>;
     /**
      * Calls the `count` function for the column given as the argument.
      *
@@ -218,7 +245,7 @@ export declare class FunctionModule<DB, TB extends keyof DB> {
      *
      * ```ts
      * db.selectFrom('toy')
-     *   .select(qb => qb.fn.count('id').as('num_toys'))
+     *   .select((eb) => eb.fn.count('id').as('num_toys'))
      *   .execute()
      * ```
      */
@@ -294,7 +321,7 @@ export declare class FunctionModule<DB, TB extends keyof DB> {
      * ```ts
      * db.selectFrom('toy')
      *   .innerJoin('pet', 'pet.id', 'toy.pet_id')
-     *   .select(qb => qb.fn.countAll('toy').as('num_toys'))
+     *   .select((eb) => eb.fn.countAll('toy').as('num_toys'))
      *   .execute()
      * ```
      */
@@ -333,7 +360,7 @@ export declare class FunctionModule<DB, TB extends keyof DB> {
      *
      * ```ts
      * db.selectFrom('toy')
-     *   .select(qb => qb.fn.max('price').as('max_price'))
+     *   .select((eb) => eb.fn.max('price').as('max_price'))
      *   .execute()
      * ```
      *
@@ -385,7 +412,7 @@ export declare class FunctionModule<DB, TB extends keyof DB> {
      *
      * ```ts
      * db.selectFrom('toy')
-     *   .select(qb => qb.fn.min('price').as('min_price'))
+     *   .select((eb) => eb.fn.min('price').as('min_price'))
      *   .execute()
      * ```
      *
@@ -433,7 +460,7 @@ export declare class FunctionModule<DB, TB extends keyof DB> {
      *
      * ```ts
      * db.selectFrom('toy')
-     *   .select(qb => qb.fn.sum('price').as('total_price'))
+     *   .select((eb) => eb.fn.sum('price').as('total_price'))
      *   .execute()
      * ```
      *
@@ -470,6 +497,7 @@ export declare class FunctionModule<DB, TB extends keyof DB> {
      */
     sum<O extends number | string | bigint | null = number | string | bigint, C extends SimpleReferenceExpression<DB, TB> = SimpleReferenceExpression<DB, TB>>(column: C): AggregateFunctionBuilder<DB, TB, O>;
 }
+export declare function createFunctionModule<DB, TB extends keyof DB>(): FunctionModule<DB, TB>;
 declare type OutputBoundStringReference<DB, TB extends keyof DB, C extends StringReference<DB, TB>, O> = IsNever<O> extends true ? C : Equals<ExtractTypeFromReferenceExpression<DB, TB, C> | null, O | null> extends true ? C : never;
 declare type StringReferenceBoundAggregateFunctionBuilder<DB, TB extends keyof DB, C extends StringReference<DB, TB>, O> = AggregateFunctionBuilder<DB, TB, ExtractTypeFromReferenceExpression<DB, TB, C> | (null extends O ? null : never)>;
 export {};