kysely 0.23.3 → 0.23.5

package/dist/esm/query-creator.d.ts

@@ -198,6 +198,8 @@ export declare class QueryCreator<DB> {
      *
      * ### Examples
      *
+     * Deleting person with id 1:
+     *
      * ```ts
      * const result = await db
      *   .deleteFrom('person')
@@ -206,7 +208,34 @@ export declare class QueryCreator<DB> {
      *
      * console.log(result.numDeletedRows)
      * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * delete from "person" where "person"."id" = $1
+     * ```
+     *
+     * Some databases such as MySQL support deleting from multiple tables:
+     *
+     * ```ts
+     * const result = await db
+     *   .deleteFrom(['person', 'pet'])
+     *   .using('person')
+     *   .innerJoin('pet', 'pet.owner_id', '=', 'person.id')
+     *   .where('person.id', '=', 1)
+     *   .executeTakeFirst()
+     * ```
+     *
+     * The generated SQL (MySQL):
+     *
+     * ```sql
+     * delete from `person`, `pet`
+     * using `person`
+     * inner join `pet` on `pet`.`owner_id` = `person`.`id`
+     * where `person`.`id` = ?
+     * ```
      */
+    deleteFrom<TR extends TableReference<DB>>(tables: TR[]): DeleteQueryBuilder<From<DB, TR>, FromTables<DB, never, TR>, DeleteResult>;
     deleteFrom<TR extends TableReference<DB>>(table: TR): DeleteQueryBuilder<From<DB, TR>, FromTables<DB, never, TR>, DeleteResult>;
     /**
      * Creates an update query.

package/dist/esm/query-creator.js

@@ -103,30 +103,11 @@ export class QueryCreator {
             queryNode: InsertQueryNode.create(parseTable(table), this.#props.withNode, true),
         });
     }
-    /**
-     * Creates a delete query.
-     *
-     * See the {@link DeleteQueryBuilder.where} method for examples on how to specify
-     * a where clause for the delete operation.
-     *
-     * The return value of the query is an instance of {@link DeleteResult}.
-     *
-     * ### Examples
-     *
-     * ```ts
-     * const result = await db
-     *   .deleteFrom('person')
-     *   .where('person.id', '=', 1)
-     *   .executeTakeFirst()
-     *
-     * console.log(result.numDeletedRows)
-     * ```
-     */
-    deleteFrom(table) {
+    deleteFrom(tables) {
         return new DeleteQueryBuilder({
             queryId: createQueryId(),
             executor: this.#props.executor,
-            queryNode: DeleteQueryNode.create(parseTableExpression(table), this.#props.withNode),
+            queryNode: DeleteQueryNode.create(parseTableExpressionOrList(tables), this.#props.withNode),
         });
     }
     /**

package/dist/esm/raw-builder/raw-builder.d.ts

@@ -93,6 +93,10 @@ export declare class RawBuilder<O> implements Expression<O> {
      * This method call doesn't change the SQL in any way. This methods simply
      * returns a copy of this `RawBuilder` with a new output type.
      */
+    $castTo<T>(): RawBuilder<T>;
+    /**
+     * @deprecated Use `$castTo` instead.
+     */
     castTo<T>(): RawBuilder<T>;
     /**
      * Adds a plugin for this SQL snippet.

package/dist/esm/raw-builder/raw-builder.js

@@ -29,9 +29,15 @@ export class RawBuilder {
      * This method call doesn't change the SQL in any way. This methods simply
      * returns a copy of this `RawBuilder` with a new output type.
      */
-    castTo() {
+    $castTo() {
         return new RawBuilder({ ...this.#props });
     }
+    /**
+     * @deprecated Use `$castTo` instead.
+     */
+    castTo() {
+        return this.$castTo();
+    }
     /**
      * Adds a plugin for this SQL snippet.
      */
@@ -65,7 +71,7 @@ export class RawBuilder {
 export function isRawBuilder(obj) {
     return (isObject(obj) &&
         isFunction(obj.as) &&
-        isFunction(obj.castTo) &&
+        isFunction(obj.$castTo) &&
         isFunction(obj.withPlugin) &&
         isFunction(obj.toOperationNode) &&
         isFunction(obj.execute));

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

@@ -52,7 +52,11 @@ export declare class AlterTableBuilder implements ColumnAlteringInterface {
     /**
      * Calls the given function passing `this` as the only argument.
      *
-     * See {@link CreateTableBuilder.call}
+     * See {@link CreateTableBuilder.$call}
+     */
+    $call<T>(func: (qb: this) => T): T;
+    /**
+     * @deprecated Use `$call` instead
      */
     call<T>(func: (qb: this) => T): T;
 }

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

@@ -126,11 +126,17 @@ export class AlterTableBuilder {
     /**
      * Calls the given function passing `this` as the only argument.
      *
-     * See {@link CreateTableBuilder.call}
+     * See {@link CreateTableBuilder.$call}
      */
-    call(func) {
+    $call(func) {
         return func(this);
     }
+    /**
+     * @deprecated Use `$call` instead
+     */
+    call(func) {
+        return this.$call(func);
+    }
 }
 export class AlterTableColumnAlteringBuilder {
     #props;

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

@@ -8,6 +8,12 @@ import { Expression } from '../expression/expression.js';
 export declare class CreateIndexBuilder implements OperationNodeSource, Compilable {
     #private;
     constructor(props: CreateIndexBuilderProps);
+    /**
+     * Adds the "if not exists" modifier.
+     *
+     * If the index already exists, no error is thrown if this method has been called.
+     */
+    ifNotExists(): CreateIndexBuilder;
     /**
      * Makes the index unique.
      */

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

@@ -11,6 +11,19 @@ export class CreateIndexBuilder {
     constructor(props) {
         this.#props = freeze(props);
     }
+    /**
+     * Adds the "if not exists" modifier.
+     *
+     * If the index already exists, no error is thrown if this method has been called.
+     */
+    ifNotExists() {
+        return new CreateIndexBuilder({
+            ...this.#props,
+            node: CreateIndexNode.cloneWith(this.#props.node, {
+                ifNotExists: true,
+            }),
+        });
+    }
     /**
      * Makes the index unique.
      */

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

@@ -211,7 +211,7 @@ export declare class CreateTableBuilder<TB extends string, C extends string = ne
      * ```ts
      * db.schema
      *   .createTable('test')
-     *   .call((builder) => builder.addColumn('id', 'integer'))
+     *   .$call((builder) => builder.addColumn('id', 'integer'))
      *   .execute()
      * ```
      *
@@ -231,10 +231,14 @@ export declare class CreateTableBuilder<TB extends string, C extends string = ne
      *
      * db.schema
      *   .createTable('test')
-     *   .call(addDefaultColumns)
+     *   .$call(addDefaultColumns)
      *   .execute()
      * ```
      */
+    $call<T>(func: (qb: this) => T): T;
+    /**
+     * @deprecated Use `$call` instead
+     */
     call<T>(func: (qb: this) => T): T;
     toOperationNode(): CreateTableNode;
     compile(): CompiledQuery;

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

@@ -276,7 +276,7 @@ export class CreateTableBuilder {
      * ```ts
      * db.schema
      *   .createTable('test')
-     *   .call((builder) => builder.addColumn('id', 'integer'))
+     *   .$call((builder) => builder.addColumn('id', 'integer'))
      *   .execute()
      * ```
      *
@@ -296,13 +296,19 @@ export class CreateTableBuilder {
      *
      * db.schema
      *   .createTable('test')
-     *   .call(addDefaultColumns)
+     *   .$call(addDefaultColumns)
      *   .execute()
      * ```
      */
-    call(func) {
+    $call(func) {
         return func(this);
     }
+    /**
+     * @deprecated Use `$call` instead
+     */
+    call(func) {
+        return this.$call(func);
+    }
     toOperationNode() {
         return this.#props.executor.transformQuery(this.#props.node, this.#props.queryId);
     }

package/dist/esm/util/type-utils.d.ts

@@ -96,9 +96,22 @@ export declare type AnyAliasedColumnWithTable<DB, TB extends keyof DB> = {
  * Extracts the item type of an array.
  */
 export declare type ArrayItemType<T> = T extends ReadonlyArray<infer I> ? I : never;
+/**
+ * Any select query builder.
+ */
 export declare type AnySelectQueryBuilder = SelectQueryBuilder<any, any, any>;
-export declare type SingleResultType<O> = O extends InsertResult ? O : O extends DeleteResult ? O : O extends UpdateResult ? O : O | undefined;
+export declare type SimplifySingleResult<O> = O extends InsertResult ? O : O extends DeleteResult ? O : O extends UpdateResult ? O : Simplify<O> | undefined;
+export declare type SimplifyResult<O> = O extends InsertResult ? O : O extends DeleteResult ? O : O extends UpdateResult ? O : Simplify<O>;
+export declare type Simplify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+/**
+ * Represents a database row whose column names and their types are unknown.
+ */
 export declare type UnknownRow = Record<string, unknown>;
+/**
+ * Makes all properties of object type `T` nullable.
+ */
 export declare type Nullable<T> = {
     [P in keyof T]: T[P] | null;
 };
@@ -123,5 +136,11 @@ export declare type Nullable<T> = {
  * // { name: string, age: number, species?: 'cat' | 'dog' }
  */
 export declare type MergePartial<T1, T2> = T1 & Partial<Omit<T2, keyof T1>>;
+/**
+ * Evaluates to `true` if `T` is `never`.
+ */
 export declare type IsNever<T> = [T] extends [never] ? true : false;
+/**
+ * Evaluates to `true` if the types `T` and `U` are equal.
+ */
 export declare type Equals<T, U> = (<G>() => G extends T ? 1 : 2) extends <G>() => G extends U ? 1 : 2 ? true : false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.23.3",
+  "version": "0.23.5",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",