kysely 0.27.5 → 0.28.0

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

@@ -64,6 +64,24 @@ class RuntimeDriver {
     rollbackTransaction(connection) {
         return this.#driver.rollbackTransaction(connection);
     }
+    savepoint(connection, savepointName, compileQuery) {
+        if (this.#driver.savepoint) {
+            return this.#driver.savepoint(connection, savepointName, compileQuery);
+        }
+        throw new Error('The `savepoint` method is not supported by this driver');
+    }
+    rollbackToSavepoint(connection, savepointName, compileQuery) {
+        if (this.#driver.rollbackToSavepoint) {
+            return this.#driver.rollbackToSavepoint(connection, savepointName, compileQuery);
+        }
+        throw new Error('The `rollbackToSavepoint` method is not supported by this driver');
+    }
+    releaseSavepoint(connection, savepointName, compileQuery) {
+        if (this.#driver.releaseSavepoint) {
+            return this.#driver.releaseSavepoint(connection, savepointName, compileQuery);
+        }
+        throw new Error('The `releaseSavepoint` method is not supported by this driver');
+    }
     async destroy() {
         if (!this.#initPromise) {
             return;
@@ -85,6 +103,8 @@ class RuntimeDriver {
     // the best option in this case.
     #addLogging(connection) {
         const executeQuery = connection.executeQuery;
+        const streamQuery = connection.streamQuery;
+        const dis = this;
         connection.executeQuery = async (compiledQuery) => {
             let caughtError;
             const startTime = (0, performance_now_js_1.performanceNow)();
@@ -93,12 +113,31 @@ class RuntimeDriver {
             }
             catch (error) {
                 caughtError = error;
-                await this.#logError(error, compiledQuery, startTime);
+                await dis.#logError(error, compiledQuery, startTime);
+                throw error;
+            }
+            finally {
+                if (!caughtError) {
+                    await dis.#logQuery(compiledQuery, startTime);
+                }
+            }
+        };
+        connection.streamQuery = async function* (compiledQuery, chunkSize) {
+            let caughtError;
+            const startTime = (0, performance_now_js_1.performanceNow)();
+            try {
+                for await (const result of streamQuery.call(connection, compiledQuery, chunkSize)) {
+                    yield result;
+                }
+            }
+            catch (error) {
+                caughtError = error;
+                await dis.#logError(error, compiledQuery, startTime);
                 throw error;
             }
             finally {
                 if (!caughtError) {
-                    await this.#logQuery(compiledQuery, startTime);
+                    await dis.#logQuery(compiledQuery, startTime, true);
                 }
             }
         };
@@ -111,9 +150,10 @@ class RuntimeDriver {
             queryDurationMillis: this.#calculateDurationMillis(startTime),
         }));
     }
-    async #logQuery(compiledQuery, startTime) {
+    async #logQuery(compiledQuery, startTime, isStream = false) {
         await this.#log.query(() => ({
             level: 'query',
+            isStream,
             query: compiledQuery,
             queryDurationMillis: this.#calculateDurationMillis(startTime),
         }));

package/dist/cjs/expression/expression-builder.d.ts

@@ -1,5 +1,5 @@
 import { SelectQueryBuilder } from '../query-builder/select-query-builder.js';
-import { TableExpression, From, FromTables, ExtractTableAlias, AnyAliasedTable, PickTableWithAlias } from '../parser/table-parser.js';
+import { TableExpressionOrList } from '../parser/table-parser.js';
 import { FunctionModule } from '../query-builder/function-module.js';
 import { ExtractTypeFromReferenceExpression, ReferenceExpression, SimpleReferenceExpression, StringReference } from '../parser/reference-parser.js';
 import { QueryExecutor } from '../query-executor/query-executor.js';
@@ -16,6 +16,7 @@ import { RefTuple2, RefTuple3, RefTuple4, RefTuple5, ValTuple2, ValTuple3, ValTu
 import { Selectable } from '../util/column-type.js';
 import { KyselyTypeError } from '../util/type-error.js';
 import { DataTypeExpression } from '../parser/data-type-parser.js';
+import { SelectFrom } from '../parser/select-from-parser.js';
 export interface ExpressionBuilder<DB, TB extends keyof DB> {
     /**
      * Creates a binary expression.
@@ -116,9 +117,9 @@ export interface ExpressionBuilder<DB, TB extends keyof DB> {
      * ```ts
      * const result = await db.selectFrom('person')
      *   .where(({ eb, exists, selectFrom }) =>
-     *     eb('first_name', '=', 'Jennifer').and(
-     *       exists(selectFrom('pet').whereRef('owner_id', '=', 'person.id').select('pet.id'))
-     *     )
+     *     eb('first_name', '=', 'Jennifer').and(exists(
+     *       selectFrom('pet').whereRef('owner_id', '=', 'person.id').select('pet.id')
+     *     ))
      *   )
      *   .selectAll()
      *   .execute()
@@ -209,11 +210,7 @@ export interface ExpressionBuilder<DB, TB extends keyof DB> {
      * that case Kysely typings wouldn't allow you to reference `pet.owner_id`
      * because `pet` is not joined to that query.
      */
-    selectFrom<TE extends keyof DB & string>(from: TE[]): SelectQueryBuilder<DB, TB | ExtractTableAlias<DB, TE>, {}>;
-    selectFrom<TE extends TableExpression<DB, TB>>(from: TE[]): SelectQueryBuilder<From<DB, TE>, FromTables<DB, TB, TE>, {}>;
-    selectFrom<TE extends keyof DB & string>(from: TE): SelectQueryBuilder<DB, TB | ExtractTableAlias<DB, TE>, {}>;
-    selectFrom<TE extends AnyAliasedTable<DB>>(from: TE): SelectQueryBuilder<DB & PickTableWithAlias<DB, TE>, TB | ExtractTableAlias<DB & PickTableWithAlias<DB, TE>, TE>, {}>;
-    selectFrom<TE extends TableExpression<DB, TB>>(from: TE): SelectQueryBuilder<From<DB, TE>, FromTables<DB, TB, TE>, {}>;
+    selectFrom<TE extends TableExpressionOrList<DB, TB>>(from: TE): SelectFrom<DB, TB, TE>;
     /**
      * Creates a `case` statement/operator.
      *
@@ -444,6 +441,8 @@ export interface ExpressionBuilder<DB, TB extends keyof DB> {
      * inner join "pet" on "pet"."owner_id" = "person"."id"
      * group by "person"."id"
      * ```
+     *
+     * If you need a column reference, use {@link ref}.
      */
     table<T extends TB & string>(table: T): ExpressionWrapper<DB, TB, Selectable<DB[T]>>;
     /**
@@ -918,4 +917,4 @@ export interface ExpressionBuilder<DB, TB extends keyof DB> {
 }
 export declare function createExpressionBuilder<DB, TB extends keyof DB>(executor?: QueryExecutor): ExpressionBuilder<DB, TB>;
 export declare function expressionBuilder<DB, TB extends keyof DB>(_: SelectQueryBuilder<DB, TB, any>): ExpressionBuilder<DB, TB>;
-export declare function expressionBuilder<DB, TB extends keyof DB>(): ExpressionBuilder<DB, TB>;
+export declare function expressionBuilder<DB, TB extends keyof DB = never>(): ExpressionBuilder<DB, TB>;

package/dist/cjs/helpers/postgres.d.ts

@@ -149,3 +149,51 @@ export declare function jsonObjectFrom<O>(expr: Expression<O>): RawBuilder<Simpl
 export declare function jsonBuildObject<O extends Record<string, Expression<unknown>>>(obj: O): RawBuilder<Simplify<{
     [K in keyof O]: O[K] extends Expression<infer V> ? V : never;
 }>>;
+export type MergeAction = 'INSERT' | 'UPDATE' | 'DELETE';
+/**
+ * The PostgreSQL `merge_action` function.
+ *
+ * This function can be used in a `returning` clause to get the action that was
+ * performed in a `mergeInto` query. The function returns one of the following
+ * strings: `'INSERT'`, `'UPDATE'`, or `'DELETE'`.
+ *
+ * ### Examples
+ *
+ * ```ts
+ * import { mergeAction } from 'kysely/helpers/postgres'
+ *
+ * const result = await db
+ *   .mergeInto('person as p')
+ *   .using('person_backup as pb', 'p.id', 'pb.id')
+ *   .whenMatched()
+ *   .thenUpdateSet(({ ref }) => ({
+ *     first_name: ref('pb.first_name'),
+ *     updated_at: ref('pb.updated_at').$castTo<string | null>(),
+ *   }))
+ *   .whenNotMatched()
+ *   .thenInsertValues(({ ref}) => ({
+ *     id: ref('pb.id'),
+ *     first_name: ref('pb.first_name'),
+ *     created_at: ref('pb.updated_at'),
+ *     updated_at: ref('pb.updated_at').$castTo<string | null>(),
+ *   }))
+ *   .returning([mergeAction().as('action'), 'p.id', 'p.updated_at'])
+ *   .execute()
+ *
+ * result[0].action
+ * ```
+ *
+ * The generated SQL (PostgreSQL):
+ *
+ * ```sql
+ * merge into "person" as "p"
+ * using "person_backup" as "pb" on "p"."id" = "pb"."id"
+ * when matched then update set
+ *   "first_name" = "pb"."first_name",
+ *   "updated_at" = "pb"."updated_at"::text
+ * when not matched then insert values ("id", "first_name", "created_at", "updated_at")
+ * values ("pb"."id", "pb"."first_name", "pb"."updated_at", "pb"."updated_at")
+ * returning merge_action() as "action", "p"."id", "p"."updated_at"
+ * ```
+ */
+export declare function mergeAction(): RawBuilder<MergeAction>;

package/dist/cjs/helpers/postgres.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.jsonArrayFrom = jsonArrayFrom;
 exports.jsonObjectFrom = jsonObjectFrom;
 exports.jsonBuildObject = jsonBuildObject;
+exports.mergeAction = mergeAction;
 const sql_js_1 = require("../raw-builder/sql.js");
 /**
  * A postgres helper for aggregating a subquery (or other expression) into a JSONB array.
@@ -156,3 +157,52 @@ function jsonObjectFrom(expr) {
 function jsonBuildObject(obj) {
     return (0, sql_js_1.sql) `json_build_object(${sql_js_1.sql.join(Object.keys(obj).flatMap((k) => [sql_js_1.sql.lit(k), obj[k]]))})`;
 }
+/**
+ * The PostgreSQL `merge_action` function.
+ *
+ * This function can be used in a `returning` clause to get the action that was
+ * performed in a `mergeInto` query. The function returns one of the following
+ * strings: `'INSERT'`, `'UPDATE'`, or `'DELETE'`.
+ *
+ * ### Examples
+ *
+ * ```ts
+ * import { mergeAction } from 'kysely/helpers/postgres'
+ *
+ * const result = await db
+ *   .mergeInto('person as p')
+ *   .using('person_backup as pb', 'p.id', 'pb.id')
+ *   .whenMatched()
+ *   .thenUpdateSet(({ ref }) => ({
+ *     first_name: ref('pb.first_name'),
+ *     updated_at: ref('pb.updated_at').$castTo<string | null>(),
+ *   }))
+ *   .whenNotMatched()
+ *   .thenInsertValues(({ ref}) => ({
+ *     id: ref('pb.id'),
+ *     first_name: ref('pb.first_name'),
+ *     created_at: ref('pb.updated_at'),
+ *     updated_at: ref('pb.updated_at').$castTo<string | null>(),
+ *   }))
+ *   .returning([mergeAction().as('action'), 'p.id', 'p.updated_at'])
+ *   .execute()
+ *
+ * result[0].action
+ * ```
+ *
+ * The generated SQL (PostgreSQL):
+ *
+ * ```sql
+ * merge into "person" as "p"
+ * using "person_backup" as "pb" on "p"."id" = "pb"."id"
+ * when matched then update set
+ *   "first_name" = "pb"."first_name",
+ *   "updated_at" = "pb"."updated_at"::text
+ * when not matched then insert values ("id", "first_name", "created_at", "updated_at")
+ * values ("pb"."id", "pb"."first_name", "pb"."updated_at", "pb"."updated_at")
+ * returning merge_action() as "action", "p"."id", "p"."updated_at"
+ * ```
+ */
+function mergeAction() {
+    return (0, sql_js_1.sql) `merge_action()`;
+}

package/dist/cjs/index.d.ts

@@ -7,6 +7,7 @@ export * from './query-builder/where-interface.js';
 export * from './query-builder/returning-interface.js';
 export * from './query-builder/output-interface.js';
 export * from './query-builder/having-interface.js';
+export * from './query-builder/order-by-interface.js';
 export * from './query-builder/select-query-builder.js';
 export * from './query-builder/insert-query-builder.js';
 export * from './query-builder/update-query-builder.js';
@@ -23,6 +24,7 @@ export * from './query-builder/case-builder.js';
 export * from './query-builder/json-path-builder.js';
 export * from './query-builder/merge-query-builder.js';
 export * from './query-builder/merge-result.js';
+export * from './query-builder/order-by-item-builder.js';
 export * from './raw-builder/raw-builder.js';
 export * from './raw-builder/sql.js';
 export * from './query-executor/query-executor.js';
@@ -44,6 +46,7 @@ export * from './schema/column-definition-builder.js';
 export * from './schema/foreign-key-constraint-builder.js';
 export * from './schema/alter-table-builder.js';
 export * from './schema/create-view-builder.js';
+export * from './schema/refresh-materialized-view-builder.js';
 export * from './schema/drop-view-builder.js';
 export * from './schema/alter-column-builder.js';
 export * from './dynamic/dynamic.js';
@@ -90,6 +93,8 @@ export * from './plugin/camel-case/camel-case-plugin.js';
 export * from './plugin/deduplicate-joins/deduplicate-joins-plugin.js';
 export * from './plugin/with-schema/with-schema-plugin.js';
 export * from './plugin/parse-json-results/parse-json-results-plugin.js';
+export * from './plugin/handle-empty-in-lists/handle-empty-in-lists-plugin.js';
+export * from './plugin/handle-empty-in-lists/handle-empty-in-lists.js';
 export * from './operation-node/add-column-node.js';
 export * from './operation-node/add-constraint-node.js';
 export * from './operation-node/add-index-node.js';
@@ -102,6 +107,7 @@ export * from './operation-node/binary-operation-node.js';
 export * from './operation-node/case-node.js';
 export * from './operation-node/cast-node.js';
 export * from './operation-node/check-constraint-node.js';
+export * from './operation-node/collate-node.js';
 export * from './operation-node/column-definition-node.js';
 export * from './operation-node/column-node.js';
 export * from './operation-node/column-update-node.js';
@@ -113,6 +119,7 @@ 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/refresh-materialized-view-node.js';
 export * from './operation-node/data-type-node.js';
 export * from './operation-node/default-insert-value-node.js';
 export * from './operation-node/default-value-node.js';
@@ -154,6 +161,7 @@ export * from './operation-node/operation-node-transformer.js';
 export * from './operation-node/operation-node-visitor.js';
 export * from './operation-node/operation-node.js';
 export * from './operation-node/operator-node.js';
+export * from './operation-node/or-action-node.js';
 export * from './operation-node/or-node.js';
 export * from './operation-node/order-by-item-node.js';
 export * from './operation-node/order-by-node.js';
@@ -162,13 +170,14 @@ export * from './operation-node/over-node.js';
 export * from './operation-node/parens-node.js';
 export * from './operation-node/partition-by-item-node.js';
 export * from './operation-node/partition-by-node.js';
-export * from './operation-node/primary-constraint-node.js';
+export * from './operation-node/primary-key-constraint-node.js';
 export * from './operation-node/primitive-value-list-node.js';
 export * from './operation-node/query-node.js';
 export * from './operation-node/raw-node.js';
 export * from './operation-node/reference-node.js';
 export * from './operation-node/references-node.js';
 export * from './operation-node/rename-column-node.js';
+export * from './operation-node/rename-constraint-node.js';
 export * from './operation-node/returning-node.js';
 export * from './operation-node/schemable-identifier-node.js';
 export * from './operation-node/select-all-node.js';
@@ -198,6 +207,7 @@ export * from './util/log.js';
 export { AnyAliasedColumn, AnyAliasedColumnWithTable, AnyColumn, AnyColumnWithTable, Equals, UnknownRow, Simplify, SqlBool, Nullable, NotNull, } from './util/type-utils.js';
 export * from './util/infer-result.js';
 export { logOnce } from './util/log-once.js';
+export { createQueryId, QueryId } from './util/query-id.js';
 export { SelectExpression, SelectCallback, SelectArg, Selection, CallbackSelection, } from './parser/select-parser.js';
 export { ReferenceExpression, ReferenceExpressionOrList, SimpleReferenceExpression, StringReference, ExtractTypeFromStringReference, ExtractTypeFromReferenceExpression, } from './parser/reference-parser.js';
 export { ValueExpression, ValueExpressionOrList, } from './parser/value-parser.js';
@@ -205,7 +215,8 @@ export { SimpleTableReference, TableExpression, TableExpressionOrList, } from '.
 export { JoinReferenceExpression, JoinCallbackExpression, } from './parser/join-parser.js';
 export { InsertObject } from './parser/insert-values-parser.js';
 export { UpdateObject } from './parser/update-set-parser.js';
-export { OrderByExpression, OrderByDirectionExpression, } from './parser/order-by-parser.js';
+export { OrderByExpression, OrderByDirectionExpression, OrderByModifiers, OrderByDirection, OrderByModifiersCallbackExpression, } from './parser/order-by-parser.js';
 export { ComparisonOperatorExpression, OperandValueExpression, OperandValueExpressionOrList, FilterObject, } from './parser/binary-operation-parser.js';
 export { ExistsExpression } from './parser/unary-operation-parser.js';
 export { OperandExpression, ExpressionOrFactory, } from './parser/expression-parser.js';
+export { Collation } from './parser/collate-parser.js';

package/dist/cjs/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logOnce = exports.expressionBuilder = void 0;
+exports.createQueryId = exports.logOnce = exports.expressionBuilder = void 0;
 __exportStar(require("./kysely.js"), exports);
 __exportStar(require("./query-creator.js"), exports);
 __exportStar(require("./expression/expression.js"), exports);
@@ -25,6 +25,7 @@ __exportStar(require("./query-builder/where-interface.js"), exports);
 __exportStar(require("./query-builder/returning-interface.js"), exports);
 __exportStar(require("./query-builder/output-interface.js"), exports);
 __exportStar(require("./query-builder/having-interface.js"), exports);
+__exportStar(require("./query-builder/order-by-interface.js"), exports);
 __exportStar(require("./query-builder/select-query-builder.js"), exports);
 __exportStar(require("./query-builder/insert-query-builder.js"), exports);
 __exportStar(require("./query-builder/update-query-builder.js"), exports);
@@ -41,6 +42,7 @@ __exportStar(require("./query-builder/case-builder.js"), exports);
 __exportStar(require("./query-builder/json-path-builder.js"), exports);
 __exportStar(require("./query-builder/merge-query-builder.js"), exports);
 __exportStar(require("./query-builder/merge-result.js"), exports);
+__exportStar(require("./query-builder/order-by-item-builder.js"), exports);
 __exportStar(require("./raw-builder/raw-builder.js"), exports);
 __exportStar(require("./raw-builder/sql.js"), exports);
 __exportStar(require("./query-executor/query-executor.js"), exports);
@@ -62,6 +64,7 @@ __exportStar(require("./schema/column-definition-builder.js"), exports);
 __exportStar(require("./schema/foreign-key-constraint-builder.js"), exports);
 __exportStar(require("./schema/alter-table-builder.js"), exports);
 __exportStar(require("./schema/create-view-builder.js"), exports);
+__exportStar(require("./schema/refresh-materialized-view-builder.js"), exports);
 __exportStar(require("./schema/drop-view-builder.js"), exports);
 __exportStar(require("./schema/alter-column-builder.js"), exports);
 __exportStar(require("./dynamic/dynamic.js"), exports);
@@ -108,6 +111,8 @@ __exportStar(require("./plugin/camel-case/camel-case-plugin.js"), exports);
 __exportStar(require("./plugin/deduplicate-joins/deduplicate-joins-plugin.js"), exports);
 __exportStar(require("./plugin/with-schema/with-schema-plugin.js"), exports);
 __exportStar(require("./plugin/parse-json-results/parse-json-results-plugin.js"), exports);
+__exportStar(require("./plugin/handle-empty-in-lists/handle-empty-in-lists-plugin.js"), exports);
+__exportStar(require("./plugin/handle-empty-in-lists/handle-empty-in-lists.js"), exports);
 __exportStar(require("./operation-node/add-column-node.js"), exports);
 __exportStar(require("./operation-node/add-constraint-node.js"), exports);
 __exportStar(require("./operation-node/add-index-node.js"), exports);
@@ -120,6 +125,7 @@ __exportStar(require("./operation-node/binary-operation-node.js"), exports);
 __exportStar(require("./operation-node/case-node.js"), exports);
 __exportStar(require("./operation-node/cast-node.js"), exports);
 __exportStar(require("./operation-node/check-constraint-node.js"), exports);
+__exportStar(require("./operation-node/collate-node.js"), exports);
 __exportStar(require("./operation-node/column-definition-node.js"), exports);
 __exportStar(require("./operation-node/column-node.js"), exports);
 __exportStar(require("./operation-node/column-update-node.js"), exports);
@@ -131,6 +137,7 @@ __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/refresh-materialized-view-node.js"), exports);
 __exportStar(require("./operation-node/data-type-node.js"), exports);
 __exportStar(require("./operation-node/default-insert-value-node.js"), exports);
 __exportStar(require("./operation-node/default-value-node.js"), exports);
@@ -172,6 +179,7 @@ __exportStar(require("./operation-node/operation-node-transformer.js"), exports)
 __exportStar(require("./operation-node/operation-node-visitor.js"), exports);
 __exportStar(require("./operation-node/operation-node.js"), exports);
 __exportStar(require("./operation-node/operator-node.js"), exports);
+__exportStar(require("./operation-node/or-action-node.js"), exports);
 __exportStar(require("./operation-node/or-node.js"), exports);
 __exportStar(require("./operation-node/order-by-item-node.js"), exports);
 __exportStar(require("./operation-node/order-by-node.js"), exports);
@@ -180,13 +188,14 @@ __exportStar(require("./operation-node/over-node.js"), exports);
 __exportStar(require("./operation-node/parens-node.js"), exports);
 __exportStar(require("./operation-node/partition-by-item-node.js"), exports);
 __exportStar(require("./operation-node/partition-by-node.js"), exports);
-__exportStar(require("./operation-node/primary-constraint-node.js"), exports);
+__exportStar(require("./operation-node/primary-key-constraint-node.js"), exports);
 __exportStar(require("./operation-node/primitive-value-list-node.js"), exports);
 __exportStar(require("./operation-node/query-node.js"), exports);
 __exportStar(require("./operation-node/raw-node.js"), exports);
 __exportStar(require("./operation-node/reference-node.js"), exports);
 __exportStar(require("./operation-node/references-node.js"), exports);
 __exportStar(require("./operation-node/rename-column-node.js"), exports);
+__exportStar(require("./operation-node/rename-constraint-node.js"), exports);
 __exportStar(require("./operation-node/returning-node.js"), exports);
 __exportStar(require("./operation-node/schemable-identifier-node.js"), exports);
 __exportStar(require("./operation-node/select-all-node.js"), exports);
@@ -216,3 +225,5 @@ __exportStar(require("./util/log.js"), exports);
 __exportStar(require("./util/infer-result.js"), exports);
 var log_once_js_1 = require("./util/log-once.js");
 Object.defineProperty(exports, "logOnce", { enumerable: true, get: function () { return log_once_js_1.logOnce; } });
+var query_id_js_1 = require("./util/query-id.js");
+Object.defineProperty(exports, "createQueryId", { enumerable: true, get: function () { return query_id_js_1.createQueryId; } });