kysely 0.27.0 → 0.27.2

package/dist/esm/migration/migrator.d.ts

@@ -1,6 +1,7 @@
 import { Kysely } from '../kysely.js';
 export declare const DEFAULT_MIGRATION_TABLE = "kysely_migration";
 export declare const DEFAULT_MIGRATION_LOCK_TABLE = "kysely_migration_lock";
+export declare const DEFAULT_ALLOW_UNORDERED_MIGRATIONS = false;
 export declare const MIGRATION_LOCK_ID = "migration_lock";
 export declare const NO_MIGRATIONS: NoMigrations;
 export interface Migration {
@@ -58,7 +59,7 @@ export declare class Migrator {
      * This method goes through all possible migrations provided by the provider and runs the
      * ones whose names come alphabetically after the last migration that has been run. If the
      * list of executed migrations doesn't match the beginning of the list of possible migrations
-     * an error is thrown.
+     * an error is returned.
      *
      * ### Examples
      *
@@ -197,6 +198,20 @@ export interface MigratorProps {
      * This only works on postgres.
      */
     readonly migrationTableSchema?: string;
+    /**
+     * Enforces whether or not migrations must be run in alpha-numeric order.
+     *
+     * When false, migrations must be run in their exact alpha-numeric order.
+     * This is checked against the migrations already run in the database
+     * (`migrationTableName'). This ensures your migrations are always run in
+     * the same order and is the safest option.
+     *
+     * When true, migrations are still run in alpha-numeric order, but
+     * the order is not checked against already-run migrations in the database.
+     * Kysely will simply run all migrations that haven't run yet, in alpha-numeric
+     * order.
+     */
+    readonly allowUnorderedMigrations?: boolean;
 }
 /**
  * All migration methods ({@link Migrator.migrateTo | migrateTo},
@@ -231,12 +246,13 @@ export interface MigrationResultSet {
      */
     readonly results?: MigrationResult[];
 }
+type MigrationDirection = 'Up' | 'Down';
 export interface MigrationResult {
     readonly migrationName: string;
     /**
      * The direction in which this migration was executed.
      */
-    readonly direction: 'Up' | 'Down';
+    readonly direction: MigrationDirection;
     /**
      * The execution status.
      *
@@ -293,3 +309,4 @@ export interface MigrationInfo {
      */
     executedAt?: Date;
 }
+export {};

package/dist/esm/migration/migrator.js

@@ -4,6 +4,7 @@ import { WithSchemaPlugin } from '../plugin/with-schema/with-schema-plugin.js';
 import { freeze, getLast } from '../util/object-utils.js';
 export const DEFAULT_MIGRATION_TABLE = 'kysely_migration';
 export const DEFAULT_MIGRATION_LOCK_TABLE = 'kysely_migration_lock';
+export const DEFAULT_ALLOW_UNORDERED_MIGRATIONS = false;
 export const MIGRATION_LOCK_ID = 'migration_lock';
 export const NO_MIGRATIONS = freeze({ __noMigrations__: true });
 /**
@@ -70,7 +71,7 @@ export class Migrator {
      * This method goes through all possible migrations provided by the provider and runs the
      * ones whose names come alphabetically after the last migration that has been run. If the
      * list of executed migrations doesn't match the beginning of the list of possible migrations
-     * an error is thrown.
+     * an error is returned.
      *
      * ### Examples
      *
@@ -107,7 +108,7 @@ export class Migrator {
      * ```
      */
     async migrateToLatest() {
-        return this.#migrate(({ migrations }) => migrations.length - 1);
+        return this.#migrate(() => ({ direction: 'Up', step: Infinity }));
     }
     /**
      * Migrate up/down to a specific migration.
@@ -133,15 +134,27 @@ export class Migrator {
      * ```
      */
     async migrateTo(targetMigrationName) {
-        return this.#migrate(({ migrations }) => {
+        return this.#migrate(({ migrations, executedMigrations, pendingMigrations, }) => {
             if (targetMigrationName === NO_MIGRATIONS) {
-                return -1;
+                return { direction: 'Down', step: Infinity };
             }
-            const index = migrations.findIndex((it) => it.name === targetMigrationName);
-            if (index === -1) {
+            if (!migrations.find((m) => m.name === targetMigrationName)) {
                 throw new Error(`migration "${targetMigrationName}" doesn't exist`);
             }
-            return index;
+            const executedIndex = executedMigrations.indexOf(targetMigrationName);
+            const pendingIndex = pendingMigrations.findIndex((m) => m.name === targetMigrationName);
+            if (executedIndex !== -1) {
+                return {
+                    direction: 'Down',
+                    step: executedMigrations.length - executedIndex - 1,
+                };
+            }
+            else if (pendingIndex !== -1) {
+                return { direction: 'Up', step: pendingIndex + 1 };
+            }
+            else {
+                throw new Error(`migration "${targetMigrationName}" isn't executed or pending`);
+            }
         });
     }
     /**
@@ -159,7 +172,7 @@ export class Migrator {
      * ```
      */
     async migrateUp() {
-        return this.#migrate(({ currentIndex, migrations }) => Math.min(currentIndex + 1, migrations.length - 1));
+        return this.#migrate(() => ({ direction: 'Up', step: 1 }));
     }
     /**
      * Migrate one step down.
@@ -176,12 +189,12 @@ export class Migrator {
      * ```
      */
     async migrateDown() {
-        return this.#migrate(({ currentIndex }) => Math.max(currentIndex - 1, -1));
+        return this.#migrate(() => ({ direction: 'Down', step: 1 }));
     }
-    async #migrate(getTargetMigrationIndex) {
+    async #migrate(getMigrationDirectionAndStep) {
         try {
             await this.#ensureMigrationTablesExists();
-            return await this.#runMigrations(getTargetMigrationIndex);
+            return await this.#runMigrations(getMigrationDirectionAndStep);
         }
         catch (error) {
             if (error instanceof MigrationResultSetError) {
@@ -199,6 +212,9 @@ export class Migrator {
     get #migrationLockTable() {
         return this.#props.migrationLockTableName ?? DEFAULT_MIGRATION_LOCK_TABLE;
     }
+    get #allowUnorderedMigrations() {
+        return (this.#props.allowUnorderedMigrations ?? DEFAULT_ALLOW_UNORDERED_MIGRATIONS);
+    }
     get #schemaPlugin() {
         if (this.#migrationTableSchema) {
             return new WithSchemaPlugin(this.#migrationTableSchema);
@@ -309,7 +325,7 @@ export class Migrator {
             .executeTakeFirst();
         return !!lockRow;
     }
-    async #runMigrations(getTargetMigrationIndex) {
+    async #runMigrations(getMigrationDirectionAndStep) {
         const adapter = this.#props.db.getExecutor().adapter;
         const lockOptions = freeze({
             lockTable: this.#props.migrationLockTableName ?? DEFAULT_MIGRATION_LOCK_TABLE,
@@ -323,15 +339,15 @@ export class Migrator {
                 if (state.migrations.length === 0) {
                     return { results: [] };
                 }
-                const targetIndex = getTargetMigrationIndex(state);
-                if (targetIndex === undefined) {
+                const { direction, step } = getMigrationDirectionAndStep(state);
+                if (step <= 0) {
                     return { results: [] };
                 }
-                if (targetIndex < state.currentIndex) {
-                    return await this.#migrateDown(db, state, targetIndex);
+                if (direction === 'Down') {
+                    return await this.#migrateDown(db, state, step);
                 }
-                else if (targetIndex > state.currentIndex) {
-                    return await this.#migrateUp(db, state, targetIndex);
+                else if (direction === 'Up') {
+                    return await this.#migrateUp(db, state, step);
                 }
                 return { results: [] };
             }
@@ -349,10 +365,21 @@ export class Migrator {
     async #getState(db) {
         const migrations = await this.#resolveMigrations();
         const executedMigrations = await this.#getExecutedMigrations(db);
-        this.#ensureMigrationsNotCorrupted(migrations, executedMigrations);
+        this.#ensureNoMissingMigrations(migrations, executedMigrations);
+        if (!this.#allowUnorderedMigrations) {
+            this.#ensureMigrationsInOrder(migrations, executedMigrations);
+        }
+        const pendingMigrations = this.#getPendingMigrations(migrations, executedMigrations);
         return freeze({
             migrations,
-            currentIndex: migrations.findIndex((it) => it.name === getLast(executedMigrations)),
+            executedMigrations,
+            lastMigration: getLast(executedMigrations),
+            pendingMigrations,
+        });
+    }
+    #getPendingMigrations(migrations, executedMigrations) {
+        return migrations.filter((migration) => {
+            return !executedMigrations.includes(migration.name);
         });
     }
     async #resolveMigrations() {
@@ -369,36 +396,43 @@ export class Migrator {
             .withPlugin(this.#schemaPlugin)
             .selectFrom(this.#migrationTable)
             .select('name')
-            .orderBy('name')
+            .orderBy(['timestamp', 'name'])
             .execute();
         return executedMigrations.map((it) => it.name);
     }
-    #ensureMigrationsNotCorrupted(migrations, executedMigrations) {
+    #ensureNoMissingMigrations(migrations, executedMigrations) {
+        // Ensure all executed migrations exist in the `migrations` list.
         for (const executed of executedMigrations) {
             if (!migrations.some((it) => it.name === executed)) {
                 throw new Error(`corrupted migrations: previously executed migration ${executed} is missing`);
             }
         }
-        // Now we know all executed migrations exist in the `migrations` list.
-        // Next we need to make sure that the executed migratiosns are the first
-        // ones in the migration list.
+    }
+    #ensureMigrationsInOrder(migrations, executedMigrations) {
+        // Ensure the executed migrations are the first ones in the migration list.
         for (let i = 0; i < executedMigrations.length; ++i) {
             if (migrations[i].name !== executedMigrations[i]) {
                 throw new Error(`corrupted migrations: expected previously executed migration ${executedMigrations[i]} to be at index ${i} but ${migrations[i].name} was found in its place. New migrations must always have a name that comes alphabetically after the last executed migration.`);
             }
         }
     }
-    async #migrateDown(db, state, targetIndex) {
-        const results = [];
-        for (let i = state.currentIndex; i > targetIndex; --i) {
-            results.push({
-                migrationName: state.migrations[i].name,
+    async #migrateDown(db, state, step) {
+        const migrationsToRollback = state.executedMigrations
+            .slice()
+            .reverse()
+            .slice(0, step)
+            .map((name) => {
+            return state.migrations.find((it) => it.name === name);
+        });
+        const results = migrationsToRollback.map((migration) => {
+            return {
+                migrationName: migration.name,
                 direction: 'Down',
                 status: 'NotExecuted',
-            });
-        }
+            };
+        });
         for (let i = 0; i < results.length; ++i) {
-            const migration = state.migrations.find((it) => it.name === results[i].migrationName);
+            const migration = migrationsToRollback[i];
             try {
                 if (migration.down) {
                     await migration.down(db);
@@ -428,17 +462,17 @@ export class Migrator {
         }
         return { results };
     }
-    async #migrateUp(db, state, targetIndex) {
-        const results = [];
-        for (let i = state.currentIndex + 1; i <= targetIndex; ++i) {
-            results.push({
-                migrationName: state.migrations[i].name,
+    async #migrateUp(db, state, step) {
+        const migrationsToRun = state.pendingMigrations.slice(0, step);
+        const results = migrationsToRun.map((migration) => {
+            return {
+                migrationName: migration.name,
                 direction: 'Up',
                 status: 'NotExecuted',
-            });
-        }
-        for (let i = 0; i < results.length; ++i) {
-            const migration = state.migrations.find((it) => it.name === results[i].migrationName);
+            };
+        });
+        for (let i = 0; i < results.length; i++) {
+            const migration = state.pendingMigrations[i];
             try {
                 await migration.up(db);
                 await db

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

@@ -19,6 +19,7 @@ export interface InsertQueryNode extends OperationNode {
     readonly ignore?: boolean;
     readonly replace?: boolean;
     readonly explain?: ExplainNode;
+    readonly defaultValues?: boolean;
 }
 /**
  * @internal

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

@@ -1,13 +1,12 @@
 import { OperationNode } from './operation-node.js';
-import { ValueNode } from './value-node.js';
 export interface LimitNode extends OperationNode {
     readonly kind: 'LimitNode';
-    readonly limit: ValueNode;
+    readonly limit: OperationNode;
 }
 /**
  * @internal
  */
 export declare const LimitNode: Readonly<{
     is(node: OperationNode): node is LimitNode;
-    create(limit: number): LimitNode;
+    create(limit: OperationNode): LimitNode;
 }>;

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

@@ -1,6 +1,5 @@
 /// <reference types="./limit-node.d.ts" />
 import { freeze } from '../util/object-utils.js';
-import { ValueNode } from './value-node.js';
 /**
  * @internal
  */
@@ -11,7 +10,7 @@ export const LimitNode = freeze({
     create(limit) {
         return freeze({
             kind: 'LimitNode',
-            limit: ValueNode.create(limit),
+            limit,
         });
     },
 });

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

@@ -1,13 +1,12 @@
 import { OperationNode } from './operation-node.js';
-import { ValueNode } from './value-node.js';
 export interface OffsetNode extends OperationNode {
     readonly kind: 'OffsetNode';
-    readonly offset: ValueNode;
+    readonly offset: OperationNode;
 }
 /**
  * @internal
  */
 export declare const OffsetNode: Readonly<{
     is(node: OperationNode): node is OffsetNode;
-    create(offset: number): OffsetNode;
+    create(offset: OperationNode): OffsetNode;
 }>;

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

@@ -1,6 +1,5 @@
 /// <reference types="./offset-node.d.ts" />
 import { freeze } from '../util/object-utils.js';
-import { ValueNode } from './value-node.js';
 /**
  * @internal
  */
@@ -11,7 +10,7 @@ export const OffsetNode = freeze({
     create(offset) {
         return freeze({
             kind: 'OffsetNode',
-            offset: ValueNode.create(offset),
+            offset,
         });
     },
 });

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

@@ -257,6 +257,7 @@ export class OperationNodeTransformer {
             ignore: node.ignore,
             replace: node.replace,
             explain: this.transformNode(node.explain),
+            defaultValues: node.defaultValues,
         });
     }
     transformValues(node) {
@@ -633,6 +634,7 @@ export class OperationNodeTransformer {
             kind: 'SelectModifierNode',
             modifier: node.modifier,
             rawModifier: this.transformNode(node.rawModifier),
+            of: this.transformNodeList(node.of),
         });
     }
     transformCreateType(node) {

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

@@ -4,12 +4,13 @@ export interface SelectModifierNode extends OperationNode {
     readonly kind: 'SelectModifierNode';
     readonly modifier?: SelectModifier;
     readonly rawModifier?: OperationNode;
+    readonly of?: ReadonlyArray<OperationNode>;
 }
 /**
  * @internal
  */
 export declare const SelectModifierNode: Readonly<{
     is(node: OperationNode): node is SelectModifierNode;
-    create(modifier: SelectModifier): SelectModifierNode;
+    create(modifier: SelectModifier, of?: ReadonlyArray<OperationNode>): SelectModifierNode;
     createWithExpression(modifier: OperationNode): SelectModifierNode;
 }>;

package/dist/esm/operation-node/select-modifier-node.js

@@ -7,10 +7,11 @@ export const SelectModifierNode = freeze({
     is(node) {
         return node.kind === 'SelectModifierNode';
     },
-    create(modifier) {
+    create(modifier, of) {
         return freeze({
             kind: 'SelectModifierNode',
             modifier,
+            of,
         });
     },
     createWithExpression(modifier) {

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

@@ -199,6 +199,23 @@ export declare class AggregateFunctionBuilder<DB, TB extends keyof DB, O = unkno
      * what the provided function returns.
      */
     $call<T>(func: (qb: this) => T): T;
+    /**
+     * Casts the expression to the given type.
+     *
+     * This method call doesn't change the SQL in any way. This methods simply
+     * returns a copy of this `AggregateFunctionBuilder` with a new output type.
+     */
+    $castTo<C>(): AggregateFunctionBuilder<DB, TB, C>;
+    /**
+     * Omit null from the expression's type.
+     *
+     * This function can be useful in cases where you know an expression can't be
+     * null, but Kysely is unable to infer it.
+     *
+     * This method call doesn't change the SQL in any way. This methods simply
+     * returns a copy of `this` with a new output type.
+     */
+    $notNull(): AggregateFunctionBuilder<DB, TB, Exclude<O, null>>;
     /**
      * Creates the OperationNode that describes how to compile this expression into SQL.
      *

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

@@ -170,6 +170,27 @@ export class AggregateFunctionBuilder {
     $call(func) {
         return func(this);
     }
+    /**
+     * Casts the expression to the given type.
+     *
+     * This method call doesn't change the SQL in any way. This methods simply
+     * returns a copy of this `AggregateFunctionBuilder` with a new output type.
+     */
+    $castTo() {
+        return new AggregateFunctionBuilder(this.#props);
+    }
+    /**
+     * Omit null from the expression's type.
+     *
+     * This function can be useful in cases where you know an expression can't be
+     * null, but Kysely is unable to infer it.
+     *
+     * This method call doesn't change the SQL in any way. This methods simply
+     * returns a copy of `this` with a new output type.
+     */
+    $notNull() {
+        return new AggregateFunctionBuilder(this.#props);
+    }
     toOperationNode() {
         return this.#props.aggregateFunctionNode;
     }

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

@@ -29,7 +29,7 @@ export declare class CaseThenBuilder<DB, TB extends keyof DB, W, O> {
      * A `then` call can be followed by {@link Whenable.when}, {@link CaseWhenBuilder.else},
      * {@link CaseWhenBuilder.end} or {@link CaseWhenBuilder.endCase} call.
      */
-    then<E extends Expression<any>>(expression: E): CaseWhenBuilder<DB, TB, W, O | ExtractTypeFromValueExpression<E>>;
+    then<E extends Expression<unknown>>(expression: E): CaseWhenBuilder<DB, TB, W, O | ExtractTypeFromValueExpression<E>>;
     then<V>(value: V): CaseWhenBuilder<DB, TB, W, O | V>;
 }
 export declare class CaseWhenBuilder<DB, TB extends keyof DB, W, O> implements Whenable<DB, TB, W, O>, Endable<DB, TB, O | null> {
@@ -48,7 +48,7 @@ export declare class CaseWhenBuilder<DB, TB extends keyof DB, W, O> implements W
      *
      * An `else` call must be followed by an {@link Endable.end} or {@link Endable.endCase} call.
      */
-    else<O2>(expression: Expression<O2>): CaseEndBuilder<DB, TB, O | O2>;
+    else<E extends Expression<unknown>>(expression: E): CaseEndBuilder<DB, TB, O | ExtractTypeFromValueExpression<E>>;
     else<V>(value: V): CaseEndBuilder<DB, TB, O | V>;
     /**
      * Adds an `end` keyword to the case operator.

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

@@ -23,6 +23,7 @@ import { ComparisonOperatorExpression, OperandValueExpressionOrList } from '../p
 import { KyselyTypeError } from '../util/type-error.js';
 import { Streamable } from '../util/streamable.js';
 import { ExpressionOrFactory } from '../parser/expression-parser.js';
+import { ValueExpression } from '../parser/value-parser.js';
 export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements WhereInterface<DB, TB>, ReturningInterface<DB, TB, O>, OperationNodeSource, Compilable<O>, Explainable, Streamable<O> {
     #private;
     constructor(props: DeleteQueryBuilderProps);
@@ -814,7 +815,7 @@ export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements W
      *   .execute()
      * ```
      */
-    limit(limit: number): DeleteQueryBuilder<DB, TB, O>;
+    limit(limit: ValueExpression<DB, TB, number>): DeleteQueryBuilder<DB, TB, O>;
     /**
      * Simply calls the provided function passing `this` as the only argument. `$call` returns
      * what the provided function returns.
@@ -877,10 +878,10 @@ export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements W
     /**
      * Change the output type of the query.
      *
-     * You should only use this method as the last resort if the types
-     * don't support your use case.
+     * This method call doesn't change the SQL in any way. This methods simply
+     * returns a copy of this `DeleteQueryBuilder` with a new output type.
      */
-    $castTo<T>(): DeleteQueryBuilder<DB, TB, T>;
+    $castTo<C>(): DeleteQueryBuilder<DB, TB, C>;
     /**
      * Narrows (parts of) the output type of the query.
      *

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

@@ -11,6 +11,7 @@ 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 { parseValueBinaryOperationOrExpression, parseReferentialBinaryOperation, } from '../parser/binary-operation-parser.js';
+import { parseValueExpression, } from '../parser/value-parser.js';
 export class DeleteQueryBuilder {
     #props;
     constructor(props) {
@@ -137,7 +138,7 @@ export class DeleteQueryBuilder {
     limit(limit) {
         return new DeleteQueryBuilder({
             ...this.#props,
-            queryNode: DeleteQueryNode.cloneWithLimit(this.#props.queryNode, LimitNode.create(limit)),
+            queryNode: DeleteQueryNode.cloneWithLimit(this.#props.queryNode, LimitNode.create(parseValueExpression(limit))),
         });
     }
     /**
@@ -211,8 +212,8 @@ export class DeleteQueryBuilder {
     /**
      * Change the output type of the query.
      *
-     * You should only use this method as the last resort if the types
-     * don't support your use case.
+     * This method call doesn't change the SQL in any way. This methods simply
+     * returns a copy of this `DeleteQueryBuilder` with a new output type.
      */
     $castTo() {
         return new DeleteQueryBuilder(this.#props);

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

@@ -138,7 +138,7 @@ export interface FunctionModule<DB, TB extends keyof DB> {
      * from "person"
      * ```
      */
-    agg<O, RE extends ReferenceExpression<DB, TB>>(name: string, args?: ReadonlyArray<RE>): AggregateFunctionBuilder<DB, TB, O>;
+    agg<O, RE extends ReferenceExpression<DB, TB> = ReferenceExpression<DB, TB>>(name: string, args?: ReadonlyArray<RE>): AggregateFunctionBuilder<DB, TB, O>;
     /**
      * Calls the `avg` function for the column or expression given as the argument.
      *

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

@@ -1,7 +1,7 @@
 import { OperationNodeSource } from '../operation-node/operation-node-source.js';
 import { CompiledQuery } from '../query-compiler/compiled-query.js';
 import { SelectExpression, SelectCallback } from '../parser/select-parser.js';
-import { InsertObjectOrList, InsertObjectOrListFactory } from '../parser/insert-values-parser.js';
+import { InsertExpression } from '../parser/insert-values-parser.js';
 import { InsertQueryNode } from '../operation-node/insert-query-node.js';
 import { QueryNode } from '../operation-node/query-node.js';
 import { NarrowPartial, SimplifyResult, SimplifySingleResult } from '../util/type-utils.js';
@@ -184,8 +184,7 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * }))
      * ```
      */
-    values(insert: InsertObjectOrList<DB, TB>): InsertQueryBuilder<DB, TB, O>;
-    values(insert: InsertObjectOrListFactory<DB, TB>): InsertQueryBuilder<DB, TB, O>;
+    values(insert: InsertExpression<DB, TB>): InsertQueryBuilder<DB, TB, O>;
     /**
      * Sets the columns to insert.
      *
@@ -240,6 +239,10 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * ```
      */
     expression(expression: ExpressionOrFactory<DB, TB, any>): InsertQueryBuilder<DB, TB, O>;
+    /**
+     * Creates an `insert into "person" default values` query.
+     */
+    defaultValues(): InsertQueryBuilder<DB, TB, O>;
     /**
      * Changes an `insert into` query to an `insert ignore into` query.
      *
@@ -563,10 +566,10 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
     /**
      * Change the output type of the query.
      *
-     * You should only use this method as the last resort if the types
-     * don't support your use case.
+     * This method call doesn't change the SQL in any way. This methods simply
+     * returns a copy of this `InsertQueryBuilder` with a new output type.
      */
-    $castTo<T>(): InsertQueryBuilder<DB, TB, T>;
+    $castTo<C>(): InsertQueryBuilder<DB, TB, C>;
     /**
      * Narrows (parts of) the output type of the query.
      *