kysely 0.21.6 → 0.22.0

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

@@ -13,13 +13,13 @@ import { Compilable } from '../util/compilable.js';
 import { QueryExecutor } from '../query-executor/query-executor.js';
 import { QueryId } from '../util/query-id.js';
 import { GroupByExpression } from '../parser/group-by-parser.js';
-import { UnionExpression } from '../parser/union-parser.js';
 import { KyselyPlugin } from '../plugin/kysely-plugin.js';
 import { WhereInterface } from './where-interface.js';
 import { NoResultErrorConstructor } from './no-result-error.js';
 import { HavingInterface } from './having-interface.js';
 import { AliasedRawBuilder } from '../raw-builder/raw-builder.js';
 import { Explainable, ExplainFormat } from '../util/explainable.js';
+import { SetOperationExpression } from '../parser/set-operation-parser.js';
 export declare class SelectQueryBuilder<DB, TB extends keyof DB, O> implements WhereInterface<DB, TB>, HavingInterface<DB, TB>, OperationNodeSource, Compilable, Explainable {
     #private;
     constructor(props: SelectQueryBuilderProps);
@@ -1202,7 +1202,7 @@ export declare class SelectQueryBuilder<DB, TB extends keyof DB, O> implements W
      *   .orderBy('name')
      * ```
      */
-    union(expression: UnionExpression<DB, O>): SelectQueryBuilder<DB, TB, O>;
+    union(expression: SetOperationExpression<DB, O>): SelectQueryBuilder<DB, TB, O>;
     /**
      * Combines another select query or raw expression to this query using `union all`.
      *
@@ -1217,7 +1217,67 @@ export declare class SelectQueryBuilder<DB, TB extends keyof DB, O> implements W
      *   .orderBy('name')
      * ```
      */
-    unionAll(expression: UnionExpression<DB, O>): SelectQueryBuilder<DB, TB, O>;
+    unionAll(expression: SetOperationExpression<DB, O>): SelectQueryBuilder<DB, TB, O>;
+    /**
+     * Combines another select query or raw expression to this query using `intersect`.
+     *
+     * The output row type of the combined query must match `this` query.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .select(['id', 'first_name as name'])
+     *   .intersect(db.selectFrom('pet').select(['id', 'name']))
+     *   .orderBy('name')
+     * ```
+     */
+    intersect(expression: SetOperationExpression<DB, O>): SelectQueryBuilder<DB, TB, O>;
+    /**
+     * Combines another select query or raw expression to this query using `intersect all`.
+     *
+     * The output row type of the combined query must match `this` query.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .select(['id', 'first_name as name'])
+     *   .intersectAll(db.selectFrom('pet').select(['id', 'name']))
+     *   .orderBy('name')
+     * ```
+     */
+    intersectAll(expression: SetOperationExpression<DB, O>): SelectQueryBuilder<DB, TB, O>;
+    /**
+     * Combines another select query or raw expression to this query using `except`.
+     *
+     * The output row type of the combined query must match `this` query.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .select(['id', 'first_name as name'])
+     *   .except(db.selectFrom('pet').select(['id', 'name']))
+     *   .orderBy('name')
+     * ```
+     */
+    except(expression: SetOperationExpression<DB, O>): SelectQueryBuilder<DB, TB, O>;
+    /**
+     * Combines another select query or raw expression to this query using `except all`.
+     *
+     * The output row type of the combined query must match `this` query.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .select(['id', 'first_name as name'])
+     *   .exceptAll(db.selectFrom('pet').select(['id', 'name']))
+     *   .orderBy('name')
+     * ```
+     */
+    exceptAll(expression: SetOperationExpression<DB, O>): SelectQueryBuilder<DB, TB, O>;
     /**
      * Simply calls the given function passing `this` as the only argument.
      *

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

@@ -12,10 +12,10 @@ import { LimitNode } from '../operation-node/limit-node.js';
 import { OffsetNode } from '../operation-node/offset-node.js';
 import { freeze } from '../util/object-utils.js';
 import { parseGroupBy, } from '../parser/group-by-parser.js';
-import { parseUnion } from '../parser/union-parser.js';
 import { NoResultError } from './no-result-error.js';
 import { IdentifierNode } from '../operation-node/identifier-node.js';
 import { ExplainNode } from '../operation-node/explain-node.js';
+import { parseSetOperation, } from '../parser/set-operation-parser.js';
 export class SelectQueryBuilder {
     #props;
     constructor(props) {
@@ -470,7 +470,7 @@ export class SelectQueryBuilder {
     union(expression) {
         return new SelectQueryBuilder({
             ...this.#props,
-            queryNode: SelectQueryNode.cloneWithUnion(this.#props.queryNode, parseUnion(expression, false)),
+            queryNode: SelectQueryNode.cloneWithSetOperation(this.#props.queryNode, parseSetOperation('union', expression, false)),
         });
     }
     /**
@@ -490,7 +490,87 @@ export class SelectQueryBuilder {
     unionAll(expression) {
         return new SelectQueryBuilder({
             ...this.#props,
-            queryNode: SelectQueryNode.cloneWithUnion(this.#props.queryNode, parseUnion(expression, true)),
+            queryNode: SelectQueryNode.cloneWithSetOperation(this.#props.queryNode, parseSetOperation('union', expression, true)),
+        });
+    }
+    /**
+     * Combines another select query or raw expression to this query using `intersect`.
+     *
+     * The output row type of the combined query must match `this` query.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .select(['id', 'first_name as name'])
+     *   .intersect(db.selectFrom('pet').select(['id', 'name']))
+     *   .orderBy('name')
+     * ```
+     */
+    intersect(expression) {
+        return new SelectQueryBuilder({
+            ...this.#props,
+            queryNode: SelectQueryNode.cloneWithSetOperation(this.#props.queryNode, parseSetOperation('intersect', expression, false)),
+        });
+    }
+    /**
+     * Combines another select query or raw expression to this query using `intersect all`.
+     *
+     * The output row type of the combined query must match `this` query.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .select(['id', 'first_name as name'])
+     *   .intersectAll(db.selectFrom('pet').select(['id', 'name']))
+     *   .orderBy('name')
+     * ```
+     */
+    intersectAll(expression) {
+        return new SelectQueryBuilder({
+            ...this.#props,
+            queryNode: SelectQueryNode.cloneWithSetOperation(this.#props.queryNode, parseSetOperation('intersect', expression, true)),
+        });
+    }
+    /**
+     * Combines another select query or raw expression to this query using `except`.
+     *
+     * The output row type of the combined query must match `this` query.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .select(['id', 'first_name as name'])
+     *   .except(db.selectFrom('pet').select(['id', 'name']))
+     *   .orderBy('name')
+     * ```
+     */
+    except(expression) {
+        return new SelectQueryBuilder({
+            ...this.#props,
+            queryNode: SelectQueryNode.cloneWithSetOperation(this.#props.queryNode, parseSetOperation('except', expression, false)),
+        });
+    }
+    /**
+     * Combines another select query or raw expression to this query using `except all`.
+     *
+     * The output row type of the combined query must match `this` query.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .select(['id', 'first_name as name'])
+     *   .exceptAll(db.selectFrom('pet').select(['id', 'name']))
+     *   .orderBy('name')
+     * ```
+     */
+    exceptAll(expression) {
+        return new SelectQueryBuilder({
+            ...this.#props,
+            queryNode: SelectQueryNode.cloneWithSetOperation(this.#props.queryNode, parseSetOperation('except', expression, true)),
         });
     }
     /**

package/dist/esm/query-compiler/default-query-compiler.d.ts

@@ -60,7 +60,6 @@ import { ColumnDefinitionNode } from '../operation-node/column-definition-node.j
 import { ModifyColumnNode } from '../operation-node/modify-column-node.js';
 import { OnDuplicateKeyNode } from '../operation-node/on-duplicate-key-node.js';
 import { ColumnNode } from '../operation-node/column-node.js';
-import { UnionNode } from '../operation-node/union-node.js';
 import { CreateViewNode } from '../operation-node/create-view-node.js';
 import { DropViewNode } from '../operation-node/drop-view-node.js';
 import { GeneratedNode } from '../operation-node/generated-node.js';
@@ -74,6 +73,11 @@ import { DropTypeNode } from '../operation-node/drop-type-node.js';
 import { ExplainNode } from '../operation-node/explain-node.js';
 import { SchemableIdentifierNode } from '../operation-node/schemable-identifier-node.js';
 import { DefaultInsertValueNode } from '../operation-node/default-insert-value-node.js';
+import { AggregateFunctionNode } from '../operation-node/aggregate-function-node.js';
+import { OverNode } from '../operation-node/over-node.js';
+import { PartitionByNode } from '../operation-node/partition-by-node.js';
+import { PartitionByItemNode } from '../operation-node/partition-by-item-node.js';
+import { SetOperationNode } from '../operation-node/set-operation-node.js';
 export declare class DefaultQueryCompiler extends OperationNodeVisitor implements QueryCompiler {
     #private;
     protected get numParameters(): number;
@@ -145,7 +149,7 @@ export declare class DefaultQueryCompiler extends OperationNodeVisitor implement
     protected visitModifyColumn(node: ModifyColumnNode): void;
     protected visitAddConstraint(node: AddConstraintNode): void;
     protected visitDropConstraint(node: DropConstraintNode): void;
-    protected visitUnion(node: UnionNode): void;
+    protected visitSetOperation(node: SetOperationNode): void;
     protected visitCreateView(node: CreateViewNode): void;
     protected visitDropView(node: DropViewNode): void;
     protected visitGenerated(node: GeneratedNode): void;
@@ -155,6 +159,10 @@ export declare class DefaultQueryCompiler extends OperationNodeVisitor implement
     protected visitDropType(node: DropTypeNode): void;
     protected visitExplain(node: ExplainNode): void;
     protected visitDefaultInsertValue(_: DefaultInsertValueNode): void;
+    protected visitAggregateFunction(node: AggregateFunctionNode): void;
+    protected visitOver(node: OverNode): void;
+    protected visitPartitionBy(node: PartitionByNode): void;
+    protected visitPartitionByItem(node: PartitionByItemNode): void;
     protected append(str: string): void;
     protected appendValue(parameter: unknown): void;
     protected getLeftIdentifierWrapper(): string;

package/dist/esm/query-compiler/default-query-compiler.js

@@ -2,10 +2,9 @@
 import { InsertQueryNode } from '../operation-node/insert-query-node.js';
 import { OperationNodeVisitor } from '../operation-node/operation-node-visitor.js';
 import { QueryNode } from '../operation-node/query-node.js';
-import { RawNode } from '../operation-node/raw-node.js';
 import { getLast, freeze, isString, isNumber, isBoolean, isNull, isDate, isBigInt, } from '../util/object-utils.js';
-import { UnionNode } from '../operation-node/union-node.js';
 import { CreateViewNode } from '../operation-node/create-view-node.js';
+import { SetOperationNode } from '../operation-node/set-operation-node.js';
 export class DefaultQueryCompiler extends OperationNodeVisitor {
     #sql = '';
     #parameters = [];
@@ -29,7 +28,7 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
         const wrapInParens = this.parentNode !== undefined &&
             !InsertQueryNode.is(this.parentNode) &&
             !CreateViewNode.is(this.parentNode) &&
-            !UnionNode.is(this.parentNode);
+            !SetOperationNode.is(this.parentNode);
         if (this.parentNode === undefined && node.explain) {
             this.visitNode(node.explain);
             this.append(' ');
@@ -71,9 +70,9 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
             this.append(' ');
             this.visitNode(node.having);
         }
-        if (node.union) {
+        if (node.setOperations) {
             this.append(' ');
-            this.compileList(node.union, ' ');
+            this.compileList(node.setOperations, ' ');
         }
         if (node.orderBy) {
             this.append(' ');
@@ -542,13 +541,7 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
         }
         if (node.expression) {
             this.append(' (');
-            if (RawNode.is(node.expression)) {
-                this.append('(');
-            }
             this.visitNode(node.expression);
-            if (RawNode.is(node.expression)) {
-                this.append(')');
-            }
             this.append(')');
         }
     }
@@ -750,12 +743,13 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
             this.append(' restrict');
         }
     }
-    visitUnion(node) {
-        this.append('union ');
+    visitSetOperation(node) {
+        this.append(node.operator);
+        this.append(' ');
         if (node.all) {
             this.append('all ');
         }
-        this.visitNode(node.union);
+        this.visitNode(node.expression);
     }
     visitCreateView(node) {
         this.append('create ');
@@ -868,6 +862,39 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
     visitDefaultInsertValue(_) {
         this.append('default');
     }
+    visitAggregateFunction(node) {
+        this.append(node.func);
+        this.append('(');
+        if (node.distinct) {
+            this.append('distinct ');
+        }
+        this.visitNode(node.column);
+        this.append(')');
+        if (node.over) {
+            this.append(' ');
+            this.visitNode(node.over);
+        }
+    }
+    visitOver(node) {
+        this.append('over(');
+        if (node.partitionBy) {
+            this.visitNode(node.partitionBy);
+            if (node.orderBy) {
+                this.append(' ');
+            }
+        }
+        if (node.orderBy) {
+            this.visitNode(node.orderBy);
+        }
+        this.append(')');
+    }
+    visitPartitionBy(node) {
+        this.append('partition by ');
+        this.compileList(node.items);
+    }
+    visitPartitionByItem(node) {
+        this.visitNode(node.partitionBy);
+    }
     append(str) {
         this.#sql += str;
     }

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

@@ -7,13 +7,14 @@ export interface Sql {
      * import { sql } from 'kysely'
      *
      * const id = 123
-     *
      * const snippet = sql<Person[]>`select * from person where id = ${id}`
      * ```
      *
      * Substitutions (the things inside `${}`) are automatically passed to the database
-     * as parameters and are NOT interpolated to the SQL string. There's no need to worry
-     * about SQL injection vulnerabilities.
+     * as parameters and are never interpolated to the SQL string. There's no need to worry
+     * about SQL injection vulnerabilities. Substitutions can be values, other `sql`
+     * expressions, queries and almost anything else Kysely can produce and they get
+     * handled correctly. See the examples below.
      *
      * If you need your substitutions to be interpreted as identifiers, value literals or
      * lists of things, see the {@link Sql.ref}, {@link Sql.table}, {@link Sql.id},
@@ -29,8 +30,7 @@ export interface Sql {
      *   .selectFrom('person')
      *   .select(
      *     // If you use `sql` in a select statement, remember to call the `as`
-     *     // method to give it an alias. Otherwise Kysely is not able to add
-     *     // the column to the result type.
+     *     // method to give it an alias.
      *     sql<string>`concat(first_name, ' ', last_name)`.as('full_name')
      *   )
      *   .where(sql`birthdate between ${date1} and ${date2}`)
@@ -97,6 +97,14 @@ export interface Sql {
      * type-safety though... But it's possible.
      */
     <T = unknown>(sqlFragments: TemplateStringsArray, ...parameters: unknown[]): RawBuilder<T>;
+    /**
+     * `sql.value(value)` is a shortcut for:
+     *
+     * ```ts
+     * sql`${value}`
+     * ```
+     */
+    value(value: unknown): RawBuilder<unknown>;
     /**
      * This can be used to add runtime column references to SQL snippets.
      *

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

@@ -19,6 +19,12 @@ export const sql = Object.assign((sqlFragments, ...parameters) => {
             rawNode: RawNode.createWithChild(parseStringReference(columnReference)),
         });
     },
+    value(value) {
+        return new RawBuilder({
+            queryId: createQueryId(),
+            rawNode: RawNode.createWithChild(parseValueExpression(value)),
+        });
+    },
     table(tableReference) {
         return new RawBuilder({
             queryId: createQueryId(),

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

@@ -4,6 +4,7 @@ import { ExpressionBuilder } from '../query-builder/expression-builder.js';
 import { InsertResult } from '../query-builder/insert-result.js';
 import { DeleteResult } from '../query-builder/delete-result.js';
 import { UpdateResult } from '../query-builder/update-result.js';
+import { AggregateFunctionBuilder, AliasedAggregateFunctionBuilder } from '../query-builder/aggregate-function-builder.js';
 /**
  * Given an object type, extracts the union of all value types.
  */
@@ -102,10 +103,13 @@ export declare type AnySelectQueryBuilder = SelectQueryBuilder<any, any, any>;
 export declare type AnyAliasedQueryBuilder = AliasedQueryBuilder<any, any, any, any>;
 export declare type AnyRawBuilder = RawBuilder<any>;
 export declare type AnyAliasedRawBuilder = AliasedRawBuilder<any, any>;
+export declare type AnyAliasedAggregateFunctionBuilder = AliasedAggregateFunctionBuilder<any, any, any, any>;
 export declare type SelectQueryBuilderFactory<DB, TB extends keyof DB> = (qb: ExpressionBuilder<DB, TB>) => AnySelectQueryBuilder;
 export declare type AliasedQueryBuilderFactory<DB, TB extends keyof DB> = (qb: ExpressionBuilder<DB, TB>) => AnyAliasedQueryBuilder;
 export declare type RawBuilderFactory<DB, TB extends keyof DB, O = any> = (qb: ExpressionBuilder<DB, TB>) => RawBuilder<O>;
 export declare type AliasedRawBuilderFactory<DB, TB extends keyof DB> = (qb: ExpressionBuilder<DB, TB>) => AnyAliasedRawBuilder;
+export declare type AggregateFunctionBuilderFactory<DB, TB extends keyof DB, O = unknown> = (qb: ExpressionBuilder<DB, TB>) => AggregateFunctionBuilder<DB, TB, O>;
+export declare type AliasedAggregateFunctionBuilderFactory<DB, TB extends keyof DB> = (qb: ExpressionBuilder<DB, TB>) => AnyAliasedAggregateFunctionBuilder;
 export declare type SingleResultType<O> = O extends InsertResult ? O : O extends DeleteResult ? O : O extends UpdateResult ? O : O | undefined;
 export declare type UnknownRow = Record<string, unknown>;
 export declare type Nullable<T> = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.21.6",
+  "version": "0.22.0",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",
@@ -41,6 +41,9 @@
   },
   "author": "Sami Koskimäki <sami@jakso.me>",
   "license": "MIT",
+  "contributors": [
+    "Igal Klebanov <igalklebanov@gmail.com>"
+  ],
   "devDependencies": {
     "@types/better-sqlite3": "^7.5.0",
     "@types/chai": "^4.3.1",

package/dist/cjs/operation-node/union-node.d.ts

@@ -1,16 +0,0 @@
-import { OperationNode } from './operation-node.js';
-import { RawNode } from './raw-node.js';
-import { SelectQueryNode } from './select-query-node.js';
-export declare type UnionExpressionNode = SelectQueryNode | RawNode;
-export interface UnionNode extends OperationNode {
-    readonly kind: 'UnionNode';
-    readonly union: UnionExpressionNode;
-    readonly all: boolean;
-}
-/**
- * @internal
- */
-export declare const UnionNode: Readonly<{
-    is(node: OperationNode): node is UnionNode;
-    create(union: UnionExpressionNode, all: boolean): UnionNode;
-}>;

package/dist/cjs/parser/union-parser.d.ts

@@ -1,5 +0,0 @@
-import { UnionNode } from '../operation-node/union-node.js';
-import { SelectQueryBuilder } from '../query-builder/select-query-builder.js';
-import { RawBuilder } from '../raw-builder/raw-builder.js';
-export declare type UnionExpression<DB, O> = SelectQueryBuilder<DB, any, O> | RawBuilder<O>;
-export declare function parseUnion(union: UnionExpression<any, any>, all: boolean): UnionNode;

package/dist/cjs/parser/union-parser.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseUnion = void 0;
-const union_node_js_1 = require("../operation-node/union-node.js");
-function parseUnion(union, all) {
-    return union_node_js_1.UnionNode.create(union.toOperationNode(), all);
-}
-exports.parseUnion = parseUnion;

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

@@ -1,16 +0,0 @@
-import { OperationNode } from './operation-node.js';
-import { RawNode } from './raw-node.js';
-import { SelectQueryNode } from './select-query-node.js';
-export declare type UnionExpressionNode = SelectQueryNode | RawNode;
-export interface UnionNode extends OperationNode {
-    readonly kind: 'UnionNode';
-    readonly union: UnionExpressionNode;
-    readonly all: boolean;
-}
-/**
- * @internal
- */
-export declare const UnionNode: Readonly<{
-    is(node: OperationNode): node is UnionNode;
-    create(union: UnionExpressionNode, all: boolean): UnionNode;
-}>;

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

@@ -1,17 +0,0 @@
-/// <reference types="./union-node.d.ts" />
-import { freeze } from '../util/object-utils.js';
-/**
- * @internal
- */
-export const UnionNode = freeze({
-    is(node) {
-        return node.kind === 'UnionNode';
-    },
-    create(union, all) {
-        return freeze({
-            kind: 'UnionNode',
-            union,
-            all,
-        });
-    },
-});

package/dist/esm/parser/union-parser.d.ts

@@ -1,5 +0,0 @@
-import { UnionNode } from '../operation-node/union-node.js';
-import { SelectQueryBuilder } from '../query-builder/select-query-builder.js';
-import { RawBuilder } from '../raw-builder/raw-builder.js';
-export declare type UnionExpression<DB, O> = SelectQueryBuilder<DB, any, O> | RawBuilder<O>;
-export declare function parseUnion(union: UnionExpression<any, any>, all: boolean): UnionNode;

package/dist/esm/parser/union-parser.js

@@ -1,5 +0,0 @@
-/// <reference types="./union-parser.d.ts" />
-import { UnionNode } from '../operation-node/union-node.js';
-export function parseUnion(union, all) {
-    return UnionNode.create(union.toOperationNode(), all);
-}