kysely 0.19.10 → 0.20.0

package/dist/esm/schema/create-table-builder.d.ts

@@ -47,17 +47,17 @@ export declare class CreateTableBuilder<TB extends string, C extends string = ne
      *   .addColumn('first_name', 'varchar(50)', (col) => col.notNull())
      *   .addColumn('last_name', 'varchar(255)')
      *   .addColumn('bank_balance', 'numeric(8, 2)')
-     *   .addColumn('data', sql`customtype`)
+     *   .addColumn('data', sql`some_type`)
      *   .addColumn('parent_id', 'integer', (col) =>
      *     col.references('person.id').onDelete('cascade'))
      *   )
      * ```
      *
-     * With this method, it's once again good to remember that Kysely just builds the query
-     * and doesn't provide the same API for all databses. For example, some databases like
-     * older MySQL don't support `references` statement in the column definition. Instead
-     * foreign key constraints need to be defined in at the level of the `create table`
-     * query. See the next example:
+     * With this method, it's once again good to remember that Kysely just builds the
+     * query and doesn't provide the same API for all databses. For example, some
+     * databases like older MySQL don't support the `references` statement in the
+     * column definition. Instead foreign key constraints need to be defined in the
+     * `create table` query. See the next example:
      *
      * ```ts
      *   .addColumn('parent_id', 'integer')
@@ -149,6 +149,60 @@ export declare class CreateTableBuilder<TB extends string, C extends string = ne
      * ```
      */
     addForeignKeyConstraint(constraintName: string, columns: C[], targetTable: string, targetColumns: string[], build?: ForeignKeyConstraintBuilderCallback): CreateTableBuilder<TB, C>;
+    /**
+     * This can be used to add any additional SQL to the front of the query __after__ the `create` keyword.
+     *
+     * Also see {@link temporary}.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.schema.createTable('person')
+     *   .modifyFront(sql`global temporary`)
+     *   .addColumn('id', 'integer', col => col => primaryKey())
+     *   .addColumn('first_name', 'varchar(64)', col => col.notNull())
+     *   .addColumn('last_name', 'varchar(64), col => col.notNull())
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (Postgres):
+     *
+     * ```sql
+     * create global temporary table "person" (
+     *   "id" integer primary key,
+     *   "first_name" varchar(64) not null,
+     *   "last_name" varchar(64) not null
+     * )
+     * ```
+     */
+    modifyFront(modifier: AnyRawBuilder): CreateTableBuilder<TB, C>;
+    /**
+     * This can be used to add any additional SQL to the end of the query.
+     *
+     * Also see {@link onCommit}.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.schema.createTable('person')
+     *   .addColumn('id', 'integer', col => col => primaryKey())
+     *   .addColumn('first_name', 'varchar(64)', col => col.notNull())
+     *   .addColumn('last_name', 'varchar(64), col => col.notNull())
+     *   .modifyEnd(sql`collate utf8_unicode_ci`)
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (MySQL):
+     *
+     * ```sql
+     * create table `person` (
+     *   `id` integer primary key,
+     *   `first_name` varchar(64) not null,
+     *   `last_name` varchar(64) not null
+     * ) collate utf8_unicode_ci
+     * ```
+     */
+    modifyEnd(modifier: AnyRawBuilder): CreateTableBuilder<TB, C>;
     toOperationNode(): CreateTableNode;
     compile(): CompiledQuery;
     execute(): Promise<void>;

package/dist/esm/schema/create-table-builder.js

@@ -12,6 +12,7 @@ import { PrimaryConstraintNode } from '../operation-node/primary-constraint-node
 import { UniqueConstraintNode } from '../operation-node/unique-constraint-node.js';
 import { CheckConstraintNode } from '../operation-node/check-constraint-node.js';
 import { parseTable } from '../parser/table-parser.js';
+import { parseOnCommitAction } from '../parser/on-commit-action-parse.js';
 /**
  * This builder can be used to create a `create table` query.
  */
@@ -43,7 +44,7 @@ export class CreateTableBuilder {
         return new CreateTableBuilder({
             ...this.#props,
             createTableNode: CreateTableNode.cloneWith(this.#props.createTableNode, {
-                onCommit,
+                onCommit: parseOnCommitAction(onCommit),
             }),
         });
     }
@@ -74,17 +75,17 @@ export class CreateTableBuilder {
      *   .addColumn('first_name', 'varchar(50)', (col) => col.notNull())
      *   .addColumn('last_name', 'varchar(255)')
      *   .addColumn('bank_balance', 'numeric(8, 2)')
-     *   .addColumn('data', sql`customtype`)
+     *   .addColumn('data', sql`some_type`)
      *   .addColumn('parent_id', 'integer', (col) =>
      *     col.references('person.id').onDelete('cascade'))
      *   )
      * ```
      *
-     * With this method, it's once again good to remember that Kysely just builds the query
-     * and doesn't provide the same API for all databses. For example, some databases like
-     * older MySQL don't support `references` statement in the column definition. Instead
-     * foreign key constraints need to be defined in at the level of the `create table`
-     * query. See the next example:
+     * With this method, it's once again good to remember that Kysely just builds the
+     * query and doesn't provide the same API for all databses. For example, some
+     * databases like older MySQL don't support the `references` statement in the
+     * column definition. Instead foreign key constraints need to be defined in the
+     * `create table` query. See the next example:
      *
      * ```ts
      *   .addColumn('parent_id', 'integer')
@@ -203,6 +204,70 @@ export class CreateTableBuilder {
             createTableNode: CreateTableNode.cloneWithConstraint(this.#props.createTableNode, builder.toOperationNode()),
         });
     }
+    /**
+     * This can be used to add any additional SQL to the front of the query __after__ the `create` keyword.
+     *
+     * Also see {@link temporary}.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.schema.createTable('person')
+     *   .modifyFront(sql`global temporary`)
+     *   .addColumn('id', 'integer', col => col => primaryKey())
+     *   .addColumn('first_name', 'varchar(64)', col => col.notNull())
+     *   .addColumn('last_name', 'varchar(64), col => col.notNull())
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (Postgres):
+     *
+     * ```sql
+     * create global temporary table "person" (
+     *   "id" integer primary key,
+     *   "first_name" varchar(64) not null,
+     *   "last_name" varchar(64) not null
+     * )
+     * ```
+     */
+    modifyFront(modifier) {
+        return new CreateTableBuilder({
+            ...this.#props,
+            createTableNode: CreateTableNode.cloneWithFrontModifier(this.#props.createTableNode, modifier.toOperationNode()),
+        });
+    }
+    /**
+     * This can be used to add any additional SQL to the end of the query.
+     *
+     * Also see {@link onCommit}.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.schema.createTable('person')
+     *   .addColumn('id', 'integer', col => col => primaryKey())
+     *   .addColumn('first_name', 'varchar(64)', col => col.notNull())
+     *   .addColumn('last_name', 'varchar(64), col => col.notNull())
+     *   .modifyEnd(sql`collate utf8_unicode_ci`)
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (MySQL):
+     *
+     * ```sql
+     * create table `person` (
+     *   `id` integer primary key,
+     *   `first_name` varchar(64) not null,
+     *   `last_name` varchar(64) not null
+     * ) collate utf8_unicode_ci
+     * ```
+     */
+    modifyEnd(modifier) {
+        return new CreateTableBuilder({
+            ...this.#props,
+            createTableNode: CreateTableNode.cloneWithEndModifier(this.#props.createTableNode, modifier.toOperationNode()),
+        });
+    }
     toOperationNode() {
         return this.#props.executor.transformQuery(this.#props.createTableNode, this.#props.queryId);
     }

package/dist/esm/schema/create-type-builder.d.ts

@@ -8,6 +8,15 @@ export declare class CreateTypeBuilder implements OperationNodeSource, Compilabl
     #private;
     constructor(props: CreateTypeBuilderProps);
     toOperationNode(): CreateTypeNode;
+    /**
+     * Creates an anum type.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.schema.createType('species').asEnum(['cat', 'dog', 'frog'])
+     * ```
+     */
     asEnum(values: string[]): CreateTypeBuilder;
     compile(): CompiledQuery;
     execute(): Promise<void>;

package/dist/esm/schema/create-type-builder.js

@@ -10,6 +10,15 @@ export class CreateTypeBuilder {
     toOperationNode() {
         return this.#props.executor.transformQuery(this.#props.createTypeNode, this.#props.queryId);
     }
+    /**
+     * Creates an anum type.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.schema.createType('species').asEnum(['cat', 'dog', 'frog'])
+     * ```
+     */
     asEnum(values) {
         return new CreateTypeBuilder({
             ...this.#props,

package/dist/esm/schema/foreign-key-constraint-builder.js

@@ -1,5 +1,6 @@
 /// <reference types="./foreign-key-constraint-builder.d.ts" />
 import { ForeignKeyConstraintNode } from '../operation-node/foreign-key-constraint-node.js';
+import { parseOnModifyForeignAction } from '../parser/on-modify-action-parser.js';
 import { preventAwait } from '../util/prevent-await.js';
 export class ForeignKeyConstraintBuilder {
     #node;
@@ -8,12 +9,12 @@ export class ForeignKeyConstraintBuilder {
     }
     onDelete(onDelete) {
         return new ForeignKeyConstraintBuilder(ForeignKeyConstraintNode.cloneWith(this.#node, {
-            onDelete,
+            onDelete: parseOnModifyForeignAction(onDelete),
         }));
     }
     onUpdate(onUpdate) {
         return new ForeignKeyConstraintBuilder(ForeignKeyConstraintNode.cloneWith(this.#node, {
-            onUpdate,
+            onUpdate: parseOnModifyForeignAction(onUpdate),
         }));
     }
     toOperationNode() {

package/dist/esm/util/deferred.d.ts

@@ -0,0 +1,7 @@
+export declare class Deferred<T> {
+    #private;
+    constructor();
+    get promise(): Promise<T>;
+    resolve: (value: T | PromiseLike<T>) => void;
+    reject: (reason?: any) => void;
+}

package/dist/esm/util/deferred.js

@@ -0,0 +1,25 @@
+/// <reference types="./deferred.d.ts" />
+export class Deferred {
+    #promise;
+    #resolve;
+    #reject;
+    constructor() {
+        this.#promise = new Promise((resolve, reject) => {
+            this.#reject = reject;
+            this.#resolve = resolve;
+        });
+    }
+    get promise() {
+        return this.#promise;
+    }
+    resolve = (value) => {
+        if (this.#resolve) {
+            this.#resolve(value);
+        }
+    };
+    reject = (reason) => {
+        if (this.#reject) {
+            this.#reject(reason);
+        }
+    };
+}

package/dist/esm/util/explainable.d.ts

@@ -0,0 +1,5 @@
+import { AnyRawBuilder } from './type-utils.js';
+export declare type ExplainFormat = 'text' | 'xml' | 'json' | 'yaml' | 'traditional' | 'tree';
+export interface Explainable {
+    explain<O extends Record<string, any> = Record<string, any>>(format?: ExplainFormat, options?: AnyRawBuilder): Promise<O[]>;
+}

package/dist/esm/util/explainable.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.19.10",
+  "version": "0.20.0",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",
@@ -44,20 +44,25 @@
   "devDependencies": {
     "@types/better-sqlite3": "^7.5.0",
     "@types/chai": "^4.3.1",
+    "@types/chai-as-promised": "^7.1.5",
     "@types/chai-subset": "^1.3.3",
     "@types/mocha": "^9.1.1",
     "@types/pg": "^8.6.5",
+    "@types/sinon": "^10.0.13",
     "better-sqlite3": "^7.5.3",
     "chai": "^4.3.6",
+    "chai-as-promised": "^7.1.1",
     "chai-subset": "^1.6.0",
     "esbuild": "^0.14.47",
     "mocha": "^10.0.0",
     "mysql2": "^2.3.3",
     "pg": "^8.7.3",
+    "pg-cursor": "^2.7.3",
     "playwright": "^1.22.2",
     "prettier": "^2.7.1",
+    "sinon": "^14.0.0",
     "tsd": "^0.21.0",
-    "typedoc": "^0.22.18",
+    "typedoc": "^0.23.6",
     "typescript": "4.7.4"
   }
 }