kysely 0.19.10 → 0.20.0

package/README.md

@@ -21,7 +21,7 @@ column names, aliases and types from selected subqueries, joined subqueries, `wi
 much anything you can think of.
 
 Of course there are cases where things cannot be typed at compile time, and Kysely offers escape
-hatches for these situations. See the [sql template tag](https://koskimas.github.io/kysely/modules.html#sql) 
+hatches for these situations. See the [sql template tag](https://koskimas.github.io/kysely/functions/sql.html) 
 and the [DynamicModule](https://koskimas.github.io/kysely/classes/DynamicModule.html#ref) for more info.
 
 If you start using Kysely and can't find something you'd want to use, please open an issue or join our
@@ -32,15 +32,21 @@ You can find a more thorough introduction [here](https://www.jakso.me/blog/kysel
 # Table of contents
 
 - [Installation](#installation)
+    - [3rd party dialects](#3rd-party-dialects)
 - [Minimal example](#minimal-example)
 - [Generating types](#generating-types)
 - [Query examples](#query-examples)
-- [Recipes](https://github.com/koskimas/kysely/tree/master/recipes)
+  - [Select queries](#select-queries)
+    - [Stream select query results](#stream-select-query-results)
+  - [Update queries](#update-queries)
+  - [Insert queries](#insert-queries)
+  - [Delete queries](#delete-queries)
 - [Migrations](#migrations)
+    - [PostgreSQL migration example](#postgresql-migration-example)
+    - [MySQL migration example](#mysql-migration-example)
 - [Deno](#deno)
 - [Browser](#browser)
-- [API reference](https://koskimas.github.io/kysely/index.html)
-- [Changelog](https://github.com/koskimas/kysely/releases)
+- [Why not just contribute to knex](#why-not-just-contribute-to-knex)
 
 # Installation
 
@@ -180,6 +186,48 @@ You can find examples of select queries in the documentation of the
 the [where method](https://koskimas.github.io/kysely/classes/SelectQueryBuilder.html#where)
 among other places.
 
+### Stream select query results
+
+*Currently only supported by `postgres` and `mysql` dialects.*
+
+```ts
+import { Pool } from 'pg'
+// or `import * as Cursor from 'pg-cursor'` depending on your tsconfig
+import Cursor from 'pg-cursor'
+import {
+    Kysely,
+    PostgresDialect,
+} from 'kysely'
+
+const db = new Kysely<Database>({
+    // PostgresDialect requires the Cursor dependency
+    dialect: new PostgresDialect({
+        pool: new Pool({
+            host: 'localhost',
+            database: 'kysely_test'
+        }),
+        cursor: Cursor
+    }),
+
+    // MysqlDialect doesn't require any special configuration
+})
+
+async function demo() {
+    for await (const male of db.selectFrom("person")
+        .selectAll()
+        .where("person.gender", "=", "male")
+        .stream()) {
+        console.log(`Hello mr. ${male.first_name}!`)
+
+        if (male.first_name === "John") {
+          // After this line the db connection is released and no more 
+          // rows are streamed from the database to the client
+          break;
+        }
+    }
+}
+```
+
 ## Update queries
 
 See the [set method](https://koskimas.github.io/kysely/classes/UpdateQueryBuilder.html#set) and the

package/dist/cjs/dialect/mysql/mysql-dialect-config.d.ts

@@ -31,9 +31,19 @@ export interface MysqlPool {
     end(callback: (error: unknown) => void): void;
 }
 export interface MysqlPoolConnection {
+    query(sql: string, parameters: ReadonlyArray<unknown>): {
+        stream: <T>(options: MysqlStreamOptions) => MysqlStream<T>;
+    };
     query(sql: string, parameters: ReadonlyArray<unknown>, callback: (error: unknown, result: MysqlQueryResult) => void): void;
     release(): void;
 }
+export interface MysqlStreamOptions {
+    highWaterMark?: number;
+    objectMode?: boolean;
+}
+export interface MysqlStream<T> {
+    [Symbol.asyncIterator](): AsyncIterableIterator<T>;
+}
 export interface MysqlOkPacket {
     affectedRows: number;
     insertId: number;

package/dist/cjs/dialect/mysql/mysql-driver.d.ts

@@ -42,6 +42,7 @@ declare class MysqlConnection implements DatabaseConnection {
     #private;
     constructor(rawConnection: MysqlPoolConnection);
     executeQuery<O>(compiledQuery: CompiledQuery): Promise<QueryResult<O>>;
+    streamQuery<O>(compiledQuery: CompiledQuery, chunkSize: number): AsyncIterableIterator<QueryResult<O>>;
     [PRIVATE_RELEASE_METHOD](): void;
 }
 export {};

package/dist/cjs/dialect/mysql/mysql-driver.js

@@ -124,6 +124,31 @@ class MysqlConnection {
             });
         });
     }
+    async *streamQuery(compiledQuery, chunkSize) {
+        const stream = this.#rawConnection
+            .query(compiledQuery.sql, compiledQuery.parameters)
+            .stream({
+            objectMode: true,
+        });
+        try {
+            for await (const row of stream) {
+                yield {
+                    rows: [row],
+                };
+            }
+        }
+        catch (ex) {
+            if (ex &&
+                typeof ex === 'object' &&
+                'code' in ex &&
+                // @ts-ignore
+                ex.code === 'ERR_STREAM_PREMATURE_CLOSE') {
+                // Most likely because of https://github.com/mysqljs/mysql/blob/master/lib/protocol/sequences/Query.js#L220
+                return;
+            }
+            throw ex;
+        }
+    }
     [PRIVATE_RELEASE_METHOD]() {
         this.#rawConnection.release();
     }

package/dist/cjs/dialect/mysql/mysql-introspector.js

@@ -30,6 +30,8 @@ class MysqlIntrospector {
             'extra',
         ])
             .where('table_schema', '=', (0, sql_js_1.sql) `database()`)
+            .orderBy('table_name')
+            .orderBy('column_name')
             .castTo();
         if (!options.withInternalKyselyTables) {
             query = query

package/dist/cjs/dialect/mysql/mysql-query-compiler.d.ts

@@ -1,6 +1,11 @@
 import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
 export declare class MysqlQueryCompiler extends DefaultQueryCompiler {
     protected getCurrentParameterPlaceholder(): string;
+    protected getLeftExplainOptionsWrapper(): string;
+    protected getExplainOptionAssignment(): string;
+    protected getExplainOptionsDelimiter(): string;
+    protected getRightExplainOptionsWrapper(): string;
     protected getLeftIdentifierWrapper(): string;
     protected getRightIdentifierWrapper(): string;
+    protected sanitizeIdentifier(identifier: string): string;
 }

package/dist/cjs/dialect/mysql/mysql-query-compiler.js

@@ -2,15 +2,31 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MysqlQueryCompiler = void 0;
 const default_query_compiler_js_1 = require("../../query-compiler/default-query-compiler.js");
+const ID_WRAP_REGEX = /`/g;
 class MysqlQueryCompiler extends default_query_compiler_js_1.DefaultQueryCompiler {
     getCurrentParameterPlaceholder() {
         return '?';
     }
+    getLeftExplainOptionsWrapper() {
+        return '';
+    }
+    getExplainOptionAssignment() {
+        return '=';
+    }
+    getExplainOptionsDelimiter() {
+        return ' ';
+    }
+    getRightExplainOptionsWrapper() {
+        return '';
+    }
     getLeftIdentifierWrapper() {
         return '`';
     }
     getRightIdentifierWrapper() {
         return '`';
     }
+    sanitizeIdentifier(identifier) {
+        return identifier.replace(ID_WRAP_REGEX, '``');
+    }
 }
 exports.MysqlQueryCompiler = MysqlQueryCompiler;

package/dist/cjs/dialect/postgres/postgres-dialect-config.d.ts

@@ -1,4 +1,14 @@
 import { DatabaseConnection } from '../../driver/database-connection.js';
+export declare type PostgresCursorConstructor = new <T>(sql: string, parameters: readonly unknown[]) => PostgresCursor<T>;
+export declare type PostgresCursor<T> = {
+    state: 'initialized' | 'idle' | 'submitted' | 'busy';
+    read: (rowsCount: number) => Promise<T[]>;
+} | {
+    state: 'done';
+} | {
+    state: 'error';
+    _error: Error;
+};
 /**
  * Config for the PostgreSQL dialect.
  */
@@ -11,6 +21,19 @@ export interface PostgresDialectConfig {
      * https://node-postgres.com/api/pool
      */
     pool: PostgresPool | (() => Promise<PostgresPool>);
+    /**
+     * https://github.com/brianc/node-postgres/tree/master/packages/pg-cursor
+     * ```ts
+     * import Cursor from 'pg-cursor'
+     * // or
+     * import * as Cursor from 'pg-cursor'
+     *
+     * new PostgresDialect({
+     *  cursor: Cursor
+     * })
+     * ```
+     */
+    cursor?: PostgresCursorConstructor;
     /**
      * Called once for each created connection.
      */
@@ -30,6 +53,7 @@ export interface PostgresPool {
 }
 export interface PostgresPoolClient {
     query<R>(sql: string, parameters: ReadonlyArray<unknown>): Promise<PostgresQueryResult<R>>;
+    query<R>(cursor: PostgresCursor<R>): PostgresCursor<R>;
     release(): void;
 }
 export interface PostgresQueryResult<R> {
@@ -37,3 +61,8 @@ export interface PostgresQueryResult<R> {
     rowCount: number;
     rows: R[];
 }
+export interface PostgresStreamOptions {
+}
+export interface PostgresStream<T> {
+    [Symbol.asyncIterator](): AsyncIterableIterator<T>;
+}

package/dist/cjs/dialect/postgres/postgres-driver.d.ts

@@ -1,7 +1,7 @@
 import { DatabaseConnection, QueryResult } from '../../driver/database-connection.js';
 import { Driver, TransactionSettings } from '../../driver/driver.js';
 import { CompiledQuery } from '../../query-compiler/compiled-query.js';
-import { PostgresDialectConfig, PostgresPoolClient } from './postgres-dialect-config.js';
+import { PostgresCursorConstructor, PostgresDialectConfig, PostgresPoolClient } from './postgres-dialect-config.js';
 declare const PRIVATE_RELEASE_METHOD: unique symbol;
 export declare class PostgresDriver implements Driver {
     #private;
@@ -38,10 +38,14 @@ export declare class PostgresDriver implements Driver {
      */
     destroy(): Promise<void>;
 }
+interface PostgresConnectionOptions {
+    cursor: PostgresCursorConstructor | null;
+}
 declare class PostgresConnection implements DatabaseConnection {
     #private;
-    constructor(client: PostgresPoolClient);
+    constructor(client: PostgresPoolClient, options: PostgresConnectionOptions);
     executeQuery<O>(compiledQuery: CompiledQuery): Promise<QueryResult<O>>;
+    streamQuery<O>(compiledQuery: CompiledQuery, chunkSize: number): AsyncIterableIterator<QueryResult<O>>;
     [PRIVATE_RELEASE_METHOD](): void;
 }
 export {};

package/dist/cjs/dialect/postgres/postgres-driver.js

@@ -21,7 +21,9 @@ class PostgresDriver {
         const client = await this.#pool.connect();
         let connection = this.#connections.get(client);
         if (!connection) {
-            connection = new PostgresConnection(client);
+            connection = new PostgresConnection(client, {
+                cursor: this.#config.cursor ?? null,
+            });
             this.#connections.set(client, connection);
             // The driver must take care of calling `onCreateConnection` when a new
             // connection is created. The `pg` module doesn't provide an async hook
@@ -60,8 +62,10 @@ class PostgresDriver {
 exports.PostgresDriver = PostgresDriver;
 class PostgresConnection {
     #client;
-    constructor(client) {
+    #options;
+    constructor(client, options) {
         this.#client = client;
+        this.#options = options;
     }
     async executeQuery(compiledQuery) {
         try {
@@ -82,6 +86,24 @@ class PostgresConnection {
             throw (0, stack_trace_utils_js_1.extendStackTrace)(err, new Error());
         }
     }
+    async *streamQuery(compiledQuery, chunkSize) {
+        if (!this.#options.cursor) {
+            throw new Error("'cursor' is not present in your postgres dialect config. It's required to make streaming work in postgres.");
+        }
+        const cursor = this.#client.query(new this.#options.cursor(compiledQuery.sql, compiledQuery.parameters));
+        while (true) {
+            if (cursor.state === 'done') {
+                break;
+            }
+            if (cursor.state === 'error') {
+                throw cursor._error;
+            }
+            const rows = await cursor.read(chunkSize);
+            yield {
+                rows,
+            };
+        }
+    }
     [PRIVATE_RELEASE_METHOD]() {
         this.#client.release();
     }

package/dist/cjs/dialect/postgres/postgres-introspector.js

@@ -21,7 +21,10 @@ class PostgresIntrospector {
         let query = this.#db
             .selectFrom('pg_catalog.pg_attribute as a')
             .innerJoin('pg_catalog.pg_class as c', 'a.attrelid', 'c.oid')
-            .innerJoin('pg_catalog.pg_tables as t', 't.tablename', 'c.relname')
+            .innerJoin('pg_catalog.pg_namespace as ns', 'c.relnamespace', 'ns.oid')
+            .innerJoin('pg_catalog.pg_tables as t', (join) => join
+            .onRef('t.tablename', '=', 'c.relname')
+            .onRef('t.schemaname', '=', 'ns.nspname'))
             .innerJoin('pg_catalog.pg_type as typ', 'a.atttypid', 'typ.oid')
             .select([
             'a.attname as column',
@@ -43,6 +46,9 @@ class PostgresIntrospector {
             .where('t.schemaname', '!=', 'information_schema')
             .where('a.attnum', '>=', 0) // No system columns
             .where('a.attisdropped', '!=', true)
+            .orderBy('t.schemaname')
+            .orderBy('t.tablename')
+            .orderBy('a.attname')
             .castTo();
         if (!options.withInternalKyselyTables) {
             query = query

package/dist/cjs/dialect/postgres/postgres-query-compiler.d.ts

@@ -1,6 +1,4 @@
 import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
 export declare class PostgresQueryCompiler extends DefaultQueryCompiler {
-    protected getCurrentParameterPlaceholder(): string;
-    protected getLeftIdentifierWrapper(): string;
-    protected getRightIdentifierWrapper(): string;
+    protected sanitizeIdentifier(identifier: string): string;
 }

package/dist/cjs/dialect/postgres/postgres-query-compiler.js

@@ -2,15 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PostgresQueryCompiler = void 0;
 const default_query_compiler_js_1 = require("../../query-compiler/default-query-compiler.js");
+const ID_WRAP_REGEX = /"/g;
 class PostgresQueryCompiler extends default_query_compiler_js_1.DefaultQueryCompiler {
-    getCurrentParameterPlaceholder() {
-        return '$' + this.numParameters;
-    }
-    getLeftIdentifierWrapper() {
-        return '"';
-    }
-    getRightIdentifierWrapper() {
-        return '"';
+    sanitizeIdentifier(identifier) {
+        return identifier.replace(ID_WRAP_REGEX, '""');
     }
 }
 exports.PostgresQueryCompiler = PostgresQueryCompiler;

package/dist/cjs/dialect/sqlite/sqlite-driver.js

@@ -69,6 +69,9 @@ class SqliteConnection {
             });
         }
     }
+    async *streamQuery() {
+        throw new Error("Sqlite driver doesn't support streaming");
+    }
 }
 class ConnectionMutex {
     #promise;

package/dist/cjs/dialect/sqlite/sqlite-introspector.js

@@ -18,6 +18,7 @@ class SqliteIntrospector {
             .where('type', '=', 'table')
             .where('name', 'not like', 'sqlite_%')
             .select('name')
+            .orderBy('name')
             .castTo();
         if (!options.withInternalKyselyTables) {
             query = query
@@ -50,6 +51,7 @@ class SqliteIntrospector {
         const columns = await db
             .selectFrom((0, sql_js_1.sql) `pragma_table_info(${table})`.as('table_info'))
             .select(['name', 'type', 'notnull', 'dflt_value'])
+            .orderBy('name')
             .execute();
         return {
             name: table,

package/dist/cjs/dialect/sqlite/sqlite-query-compiler.d.ts

@@ -1,7 +1,10 @@
 import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
 export declare class SqliteQueryCompiler extends DefaultQueryCompiler {
     protected getCurrentParameterPlaceholder(): string;
+    protected getLeftExplainOptionsWrapper(): string;
+    protected getRightExplainOptionsWrapper(): string;
     protected getLeftIdentifierWrapper(): string;
     protected getRightIdentifierWrapper(): string;
     protected getAutoIncrement(): string;
+    protected sanitizeIdentifier(identifier: string): string;
 }

package/dist/cjs/dialect/sqlite/sqlite-query-compiler.js

@@ -2,10 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SqliteQueryCompiler = void 0;
 const default_query_compiler_js_1 = require("../../query-compiler/default-query-compiler.js");
+const ID_WRAP_REGEX = /"/g;
 class SqliteQueryCompiler extends default_query_compiler_js_1.DefaultQueryCompiler {
     getCurrentParameterPlaceholder() {
         return '?';
     }
+    getLeftExplainOptionsWrapper() {
+        return '';
+    }
+    getRightExplainOptionsWrapper() {
+        return '';
+    }
     getLeftIdentifierWrapper() {
         return '"';
     }
@@ -15,5 +22,8 @@ class SqliteQueryCompiler extends default_query_compiler_js_1.DefaultQueryCompil
     getAutoIncrement() {
         return 'autoincrement';
     }
+    sanitizeIdentifier(identifier) {
+        return identifier.replace(ID_WRAP_REGEX, '""');
+    }
 }
 exports.SqliteQueryCompiler = SqliteQueryCompiler;

package/dist/cjs/driver/database-connection.d.ts

@@ -6,6 +6,7 @@ import { CompiledQuery } from '../query-compiler/compiled-query.js';
  */
 export interface DatabaseConnection {
     executeQuery<R>(compiledQuery: CompiledQuery): Promise<QueryResult<R>>;
+    streamQuery<R>(compiledQuery: CompiledQuery, chunkSize?: number): AsyncIterableIterator<QueryResult<R>>;
 }
 export interface QueryResult<O> {
     /**

package/dist/cjs/driver/dummy-driver.js

@@ -67,4 +67,7 @@ class DummyConnection {
             rows: [],
         };
     }
+    async *streamQuery() {
+        // Nothing to do here.
+    }
 }

package/dist/cjs/index.d.ts

@@ -25,7 +25,9 @@ export * from './query-compiler/default-query-compiler.js';
 export * from './query-compiler/compiled-query.js';
 export * from './schema/schema.js';
 export * from './schema/create-table-builder.js';
+export * from './schema/create-type-builder.js';
 export * from './schema/drop-table-builder.js';
+export * from './schema/drop-type-builder.js';
 export * from './schema/create-index-builder.js';
 export * from './schema/drop-index-builder.js';
 export * from './schema/create-schema-builder.js';
@@ -87,6 +89,7 @@ export * from './operation-node/constraint-node.js';
 export * from './operation-node/create-index-node.js';
 export * from './operation-node/create-schema-node.js';
 export * from './operation-node/create-table-node.js';
+export * from './operation-node/create-type-node.js';
 export * from './operation-node/create-view-node.js';
 export * from './operation-node/data-type-node.js';
 export * from './operation-node/default-value-node.js';
@@ -96,6 +99,7 @@ export * from './operation-node/drop-constraint-node.js';
 export * from './operation-node/drop-index-node.js';
 export * from './operation-node/drop-schema-node.js';
 export * from './operation-node/drop-table-node.js';
+export * from './operation-node/drop-type-node.js';
 export * from './operation-node/drop-view-node.js';
 export * from './operation-node/filter-node.js';
 export * from './operation-node/foreign-key-constraint-node.js';
@@ -145,8 +149,10 @@ export * from './operation-node/value-node.js';
 export * from './operation-node/values-node.js';
 export * from './operation-node/where-node.js';
 export * from './operation-node/with-node.js';
+export * from './operation-node/explain-node.js';
 export * from './util/column-type.js';
 export * from './util/compilable.js';
+export * from './util/explainable.js';
 export * from './util/log.js';
 export { AnyColumn, UnknownRow, AnySelectQueryBuilder, } from './util/type-utils.js';
 export { SelectExpression, SelectExpressionOrList, Selection, } from './parser/select-parser.js';

package/dist/cjs/index.js

@@ -41,7 +41,9 @@ __exportStar(require("./query-compiler/default-query-compiler.js"), exports);
 __exportStar(require("./query-compiler/compiled-query.js"), exports);
 __exportStar(require("./schema/schema.js"), exports);
 __exportStar(require("./schema/create-table-builder.js"), exports);
+__exportStar(require("./schema/create-type-builder.js"), exports);
 __exportStar(require("./schema/drop-table-builder.js"), exports);
+__exportStar(require("./schema/drop-type-builder.js"), exports);
 __exportStar(require("./schema/create-index-builder.js"), exports);
 __exportStar(require("./schema/drop-index-builder.js"), exports);
 __exportStar(require("./schema/create-schema-builder.js"), exports);
@@ -103,6 +105,7 @@ __exportStar(require("./operation-node/constraint-node.js"), exports);
 __exportStar(require("./operation-node/create-index-node.js"), exports);
 __exportStar(require("./operation-node/create-schema-node.js"), exports);
 __exportStar(require("./operation-node/create-table-node.js"), exports);
+__exportStar(require("./operation-node/create-type-node.js"), exports);
 __exportStar(require("./operation-node/create-view-node.js"), exports);
 __exportStar(require("./operation-node/data-type-node.js"), exports);
 __exportStar(require("./operation-node/default-value-node.js"), exports);
@@ -112,6 +115,7 @@ __exportStar(require("./operation-node/drop-constraint-node.js"), exports);
 __exportStar(require("./operation-node/drop-index-node.js"), exports);
 __exportStar(require("./operation-node/drop-schema-node.js"), exports);
 __exportStar(require("./operation-node/drop-table-node.js"), exports);
+__exportStar(require("./operation-node/drop-type-node.js"), exports);
 __exportStar(require("./operation-node/drop-view-node.js"), exports);
 __exportStar(require("./operation-node/filter-node.js"), exports);
 __exportStar(require("./operation-node/foreign-key-constraint-node.js"), exports);
@@ -161,6 +165,8 @@ __exportStar(require("./operation-node/value-node.js"), exports);
 __exportStar(require("./operation-node/values-node.js"), exports);
 __exportStar(require("./operation-node/where-node.js"), exports);
 __exportStar(require("./operation-node/with-node.js"), exports);
+__exportStar(require("./operation-node/explain-node.js"), exports);
 __exportStar(require("./util/column-type.js"), exports);
 __exportStar(require("./util/compilable.js"), exports);
+__exportStar(require("./util/explainable.js"), exports);
 __exportStar(require("./util/log.js"), exports);

package/dist/cjs/operation-node/create-table-node.d.ts

@@ -2,8 +2,11 @@ import { OperationNode } from './operation-node.js';
 import { TableNode } from './table-node.js';
 import { ConstraintNode } from './constraint-node.js';
 import { ColumnDefinitionNode } from './column-definition-node.js';
-export declare type OnCommitAction = 'preserve rows' | 'delete rows' | 'drop';
-export declare type CreateTableNodeParams = Omit<CreateTableNode, 'kind' | 'table' | 'columns' | 'constraints'>;
+import { ArrayItemType } from '../util/type-utils.js';
+import { RawNode } from './raw-node.js';
+export declare const ON_COMMIT_ACTIONS: string[];
+export declare type OnCommitAction = ArrayItemType<typeof ON_COMMIT_ACTIONS>;
+export declare type CreateTableNodeParams = Omit<CreateTableNode, 'kind' | 'table' | 'columns' | 'constraints' | 'frontModifiers' | 'endModifiers'>;
 export interface CreateTableNode extends OperationNode {
     readonly kind: 'CreateTableNode';
     readonly table: TableNode;
@@ -12,6 +15,8 @@ export interface CreateTableNode extends OperationNode {
     readonly temporary?: boolean;
     readonly ifNotExists?: boolean;
     readonly onCommit?: OnCommitAction;
+    readonly frontModifiers?: ReadonlyArray<RawNode>;
+    readonly endModifiers?: ReadonlyArray<RawNode>;
 }
 /**
  * @internal
@@ -21,5 +26,7 @@ export declare const CreateTableNode: Readonly<{
     create(table: TableNode): CreateTableNode;
     cloneWithColumn(createTable: CreateTableNode, column: ColumnDefinitionNode): CreateTableNode;
     cloneWithConstraint(createTable: CreateTableNode, constraint: ConstraintNode): CreateTableNode;
+    cloneWithFrontModifier(createTable: CreateTableNode, modifier: RawNode): CreateTableNode;
+    cloneWithEndModifier(createTable: CreateTableNode, modifier: RawNode): CreateTableNode;
     cloneWith(createTable: CreateTableNode, params: CreateTableNodeParams): CreateTableNode;
 }>;

package/dist/cjs/operation-node/create-table-node.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateTableNode = void 0;
+exports.CreateTableNode = exports.ON_COMMIT_ACTIONS = void 0;
 const object_utils_js_1 = require("../util/object-utils.js");
+exports.ON_COMMIT_ACTIONS = ['preserve rows', 'delete rows', 'drop'];
 /**
  * @internal
  */
@@ -30,6 +31,22 @@ exports.CreateTableNode = (0, object_utils_js_1.freeze)({
                 : (0, object_utils_js_1.freeze)([constraint]),
         });
     },
+    cloneWithFrontModifier(createTable, modifier) {
+        return (0, object_utils_js_1.freeze)({
+            ...createTable,
+            frontModifiers: createTable.frontModifiers
+                ? (0, object_utils_js_1.freeze)([...createTable.frontModifiers, modifier])
+                : (0, object_utils_js_1.freeze)([modifier]),
+        });
+    },
+    cloneWithEndModifier(createTable, modifier) {
+        return (0, object_utils_js_1.freeze)({
+            ...createTable,
+            endModifiers: createTable.endModifiers
+                ? (0, object_utils_js_1.freeze)([...createTable.endModifiers, modifier])
+                : (0, object_utils_js_1.freeze)([modifier]),
+        });
+    },
     cloneWith(createTable, params) {
         return (0, object_utils_js_1.freeze)({
             ...createTable,

package/dist/cjs/operation-node/data-type-node.d.ts

@@ -1,5 +1,5 @@
 import { OperationNode } from './operation-node.js';
-export declare type ColumnDataType = 'varchar' | `varchar(${number})` | 'text' | 'integer' | 'int2' | 'int4' | 'int8' | 'bigint' | 'boolean' | 'real' | 'double precision' | 'float4' | 'float8' | 'decimal' | `decimal(${number}, ${number})` | 'numeric' | `numeric(${number}, ${number})` | 'binary' | 'date' | 'datetime' | 'time' | 'timetz' | 'timestamp' | 'timestamptz' | 'serial' | 'bigserial' | 'uuid' | 'json' | 'jsonb' | 'blob';
+export declare type ColumnDataType = 'varchar' | `varchar(${number})` | 'text' | 'integer' | 'int2' | 'int4' | 'int8' | 'bigint' | 'boolean' | 'real' | 'double precision' | 'float4' | 'float8' | 'decimal' | `decimal(${number}, ${number})` | 'numeric' | `numeric(${number}, ${number})` | 'binary' | 'date' | 'datetime' | `datetime(${number})` | 'time' | `time(${number})` | 'timetz' | `timetz(${number})` | 'timestamp' | `timestamp(${number})` | 'timestamptz' | `timestamptz(${number})` | 'serial' | 'bigserial' | 'uuid' | 'json' | 'jsonb' | 'blob';
 export declare type DataTypeParams = Omit<DataTypeNode, 'kind' | 'dataType'>;
 export interface DataTypeNode extends OperationNode {
     readonly kind: 'DataTypeNode';

package/dist/cjs/operation-node/delete-query-node.d.ts

@@ -8,6 +8,7 @@ import { WithNode } from './with-node.js';
 import { LimitNode } from './limit-node.js';
 import { OrderByNode } from './order-by-node.js';
 import { OrderByItemNode } from './order-by-item-node.js';
+import { ExplainNode } from './explain-node.js';
 export interface DeleteQueryNode extends OperationNode {
     readonly kind: 'DeleteQueryNode';
     readonly from: FromNode;
@@ -17,6 +18,7 @@ export interface DeleteQueryNode extends OperationNode {
     readonly with?: WithNode;
     readonly orderBy?: OrderByNode;
     readonly limit?: LimitNode;
+    readonly explain?: ExplainNode;
 }
 /**
  * @internal
@@ -26,4 +28,5 @@ export declare const DeleteQueryNode: Readonly<{
     create(fromItem: TableExpressionNode, withNode?: WithNode): DeleteQueryNode;
     cloneWithOrderByItem(deleteNode: DeleteQueryNode, item: OrderByItemNode): DeleteQueryNode;
     cloneWithLimit(deleteNode: DeleteQueryNode, limit: LimitNode): DeleteQueryNode;
+    cloneWithExplain(deleteNode: DeleteQueryNode, explain: ExplainNode): DeleteQueryNode;
 }>;

package/dist/cjs/operation-node/delete-query-node.js

@@ -32,4 +32,10 @@ exports.DeleteQueryNode = (0, object_utils_js_1.freeze)({
             limit,
         });
     },
+    cloneWithExplain(deleteNode, explain) {
+        return (0, object_utils_js_1.freeze)({
+            ...deleteNode,
+            explain,
+        });
+    },
 });