kysely 0.9.8 → 0.11.0

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

@@ -18,6 +18,9 @@ import { DeleteQueryNode } from '../operation-node/delete-query-node.js';
 import { OnDuplicateKeyNode } from '../operation-node/on-duplicate-key-node.js';
 import { parseGroupBy } from '../parser/group-by-parser.js';
 import { parseUnion } from '../parser/union-parser.js';
+import { InsertResult } from './insert-result.js';
+import { UpdateResult } from './update-result.js';
+import { DeleteResult } from './delete-result.js';
 /**
  * The main query builder class.
  *
@@ -62,7 +65,7 @@ export class QueryBuilder {
      *   .whereRef('person.first_name', '=', 'pet.name')
      * ```
      *
-     * The generated SQL (postgresql):
+     * The generated SQL (PostgreSQL):
      *
      * ```sql
      * select * from "person", "pet" where "person"."first_name" = "pet"."name"
@@ -85,7 +88,7 @@ export class QueryBuilder {
      *   .execute()
      * ```
      *
-     * The generated SQL (postgresql):
+     * The generated SQL (PostgreSQL):
      *
      * ```sql
      * select "person".*, (
@@ -144,7 +147,7 @@ export class QueryBuilder {
      *   .execute()
      * ```
      *
-     * The generated SQL (postgresql):
+     * The generated SQL (PostgreSQL):
      *
      * ```sql
      * select * from "person"
@@ -170,7 +173,7 @@ export class QueryBuilder {
      *   )
      * ```
      *
-     * The generated SQL (postgresql):
+     * The generated SQL (PostgreSQL):
      *
      * ```sql
      * select * from "person"
@@ -324,7 +327,7 @@ export class QueryBuilder {
      *   .execute()
      * ```
      *
-     * The generated SQL (postgresql):
+     * The generated SQL (PostgreSQL):
      *
      * ```sql
      * select distinct "first_name" from "person"
@@ -523,15 +526,15 @@ export class QueryBuilder {
      * values to update. In addition to the column's type, the values can be `raw`
      * instances or select queries.
      *
-     * The return value is the number of affected rows. You can use the
-     * {@link QueryBuilder.returning | returning} method on supported databases
-     * to get out the updated rows.
+     * The return value of an update query is an instance of {@link UpdateResult}.
+     * You can use the {@link QueryBuilder.returning | returning} method on
+     * supported databases to get out the updated rows.
      *
      * @example
      * Update a row in `person` table:
      *
      * ```ts
-     * const numAffectedRows = await db
+     * const result = await db
      *   .updateTable('person')
      *   .set({
      *     first_name: 'Jennifer',
@@ -539,9 +542,11 @@ export class QueryBuilder {
      *   })
      *   .where('id', '=', 1)
      *   .executeTakeFirst()
+     *
+     * console.log(result.numUpdatedRows)
      * ```
      *
-     * The generated SQL (postgresql):
+     * The generated SQL (PostgreSQL):
      *
      * ```sql
      * update "person" set "first_name" = $1, "last_name" = $2 where "id" = $3
@@ -566,7 +571,7 @@ export class QueryBuilder {
      * row.id
      * ```
      *
-     * The generated SQL (postgresql):
+     * The generated SQL (PostgreSQL):
      *
      * ```sql
      * update "person" set "first_name" = $1, "last_name" = $2 where "id" = $3 returning "id"
@@ -577,7 +582,7 @@ export class QueryBuilder {
      * select queries:
      *
      * ```ts
-     * const numAffectedRows = await db
+     * const result = await db
      *   .updateTable('person')
      *   .set({
      *     first_name: 'Jennifer',
@@ -586,9 +591,11 @@ export class QueryBuilder {
      *   })
      *   .where('id', '=', 1)
      *   .executeTakeFirst()
+     *
+     * console.log(result.numUpdatedRows)
      * ```
      *
-     * The generated SQL (postgresql):
+     * The generated SQL (PostgreSQL):
      *
      * ```sql
      * update "person" set
@@ -614,7 +621,7 @@ export class QueryBuilder {
     }
     /**
      * Adds a `returning *` to an insert/update/delete query on databases
-     * that support `returning` such as postgres.
+     * that support `returning` such as PostgreSQL.
      */
     returningAll() {
         assertCanHaveReturningClause(this.#props.queryNode);
@@ -642,7 +649,7 @@ export class QueryBuilder {
      *   .execute()
      * ```
      *
-     * The generated SQL (postgresql):
+     * The generated SQL (PostgreSQL):
      *
      * ```sql
      * select "person"."first_name" as "fn"
@@ -669,7 +676,7 @@ export class QueryBuilder {
      *   .execute()
      * ```
      *
-     * The generated SQL (postgresql):
+     * The generated SQL (PostgreSQL):
      *
      * ```sql
      * select *
@@ -701,7 +708,7 @@ export class QueryBuilder {
      * someQuery('fn')
      * ```
      *
-     * The generated SQL (postgresql):
+     * The generated SQL (PostgreSQL):
      *
      * ```sql
      * select "person"."first_name" as "fn"
@@ -892,32 +899,22 @@ export class QueryBuilder {
      * Also see the {@link executeTakeFirst} and {@link executeTakeFirstOrThrow} methods.
      */
     async execute() {
-        const node = this.#props.executor.transformQuery(this.#props.queryNode, this.#props.queryId);
-        const compildQuery = this.#props.executor.compileQuery(node, this.#props.queryId);
+        const compildQuery = this.compile();
+        const query = compildQuery.query;
         const result = await this.#props.executor.executeQuery(compildQuery, this.#props.queryId);
-        if (InsertQueryNode.is(node)) {
-            if (this.#props.parseContext.adapter.supportsReturning &&
-                node.returning) {
-                return result.rows;
-            }
-            else if (result.insertedPrimaryKey != null) {
-                return [result.insertedPrimaryKey];
-            }
-            else {
-                return [];
-            }
+        if (this.#props.parseContext.adapter.supportsReturning &&
+            QueryNode.isMutating(query) &&
+            query.returning) {
+            return result.rows;
+        }
+        else if (InsertQueryNode.is(query)) {
+            return [new InsertResult(result.insertId)];
+        }
+        else if (UpdateQueryNode.is(query)) {
+            return [new UpdateResult(result.numUpdatedOrDeletedRows)];
         }
-        else if (UpdateQueryNode.is(node) || DeleteQueryNode.is(node)) {
-            if (this.#props.parseContext.adapter.supportsReturning &&
-                node.returning) {
-                return result.rows;
-            }
-            else if (result.numUpdatedOrDeletedRows != null) {
-                return [result.numUpdatedOrDeletedRows];
-            }
-            else {
-                return [];
-            }
+        else if (DeleteQueryNode.is(query)) {
+            return [new DeleteResult(result.numUpdatedOrDeletedRows)];
         }
         else {
             return result.rows;

package/dist/esm/query-builder/update-result.d.ts

@@ -0,0 +1,5 @@
+export declare class UpdateResult {
+    #private;
+    constructor(numUpdatedRows: bigint);
+    get numUpdatedRows(): bigint;
+}

package/dist/esm/query-builder/update-result.js

@@ -0,0 +1,9 @@
+export class UpdateResult {
+    #numUpdatedRows;
+    constructor(numUpdatedRows) {
+        this.#numUpdatedRows = numUpdatedRows;
+    }
+    get numUpdatedRows() {
+        return this.#numUpdatedRows;
+    }
+}

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

@@ -1,4 +1,9 @@
+import { RootOperationNode } from './query-compiler.js';
 export interface CompiledQuery {
+    readonly query: RootOperationNode;
     readonly sql: string;
     readonly parameters: ReadonlyArray<unknown>;
 }
+export declare const CompiledQuery: Readonly<{
+    raw(sql: string): CompiledQuery;
+}>;

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

@@ -1 +1,11 @@
-export {};
+import { RawNode } from '../operation-node/raw-node.js';
+import { freeze } from '../util/object-utils.js';
+export const CompiledQuery = freeze({
+    raw(sql) {
+        return freeze({
+            sql,
+            query: RawNode.createWithSql(sql),
+            parameters: freeze([]),
+        });
+    },
+});

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

@@ -62,6 +62,11 @@ 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 { GeneratedAlwaysAsNode } from '../operation-node/generated-always-as-node.js';
+import { DefaultValueNode } from '../operation-node/default-value-node.js';
+import { OnNode } from '../operation-node/on-node.js';
 export declare class DefaultQueryCompiler extends OperationNodeVisitor implements QueryCompiler {
     #private;
     protected get numParameters(): number;
@@ -91,6 +96,7 @@ export declare class DefaultQueryCompiler extends OperationNodeVisitor implement
     protected visitPrimitiveValueList(node: PrimitiveValueListNode): void;
     protected visitParens(node: ParensNode): void;
     protected visitJoin(node: JoinNode): void;
+    protected visitOn(node: OnNode): void;
     protected visitRaw(node: RawNode): void;
     protected visitOperator(node: OperatorNode): void;
     protected visitTable(node: TableNode): void;
@@ -130,6 +136,10 @@ export declare class DefaultQueryCompiler extends OperationNodeVisitor implement
     protected visitAddConstraint(node: AddConstraintNode): void;
     protected visitDropConstraint(node: DropConstraintNode): void;
     protected visitUnion(node: UnionNode): void;
+    protected visitCreateView(node: CreateViewNode): void;
+    protected visitDropView(node: DropViewNode): void;
+    protected visitGeneratedAlwaysAs(node: GeneratedAlwaysAsNode): void;
+    protected visitDefaultValue(node: DefaultValueNode): void;
     protected append(str: string): void;
     protected appendValue(parameter: unknown): void;
     protected getLeftIdentifierWrapper(): string;

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

@@ -2,6 +2,8 @@ import { OperationNodeVisitor } from '../operation-node/operation-node-visitor.j
 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';
 export class DefaultQueryCompiler extends OperationNodeVisitor {
     #sql = '';
     #parameters = [];
@@ -13,6 +15,7 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
         this.#parameters = [];
         this.visitNode(node);
         return freeze({
+            query: node,
             sql: this.getSql(),
             parameters: [...this.#parameters],
         });
@@ -21,9 +24,10 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
         return this.#sql;
     }
     visitSelectQuery(node) {
-        // This is a sub query if this is not the root node.
-        const isSubQuery = this.nodeStack.length !== 1;
-        if (isSubQuery) {
+        const wrapInParens = this.nodeStack.length !== 1 &&
+            !CreateViewNode.is(this.parentNode) &&
+            !UnionNode.is(this.parentNode);
+        if (wrapInParens) {
             this.append('(');
         }
         if (node.with) {
@@ -35,7 +39,7 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
             this.compileDistinctOn(node.distinctOnSelections);
             this.append(' ');
         }
-        if (node.isDistinct) {
+        if (node.distinct) {
             this.append('distinct');
             this.append(' ');
         }
@@ -82,7 +86,7 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
                 this.append(SELECT_MODIFIER_SQL[modifier]);
             });
         }
-        if (isSubQuery) {
+        if (wrapInParens) {
             this.append(')');
         }
     }
@@ -262,11 +266,15 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
         this.append(JOIN_TYPE_SQL[node.joinType]);
         this.append(' ');
         this.visitNode(node.table);
-        this.append(' on ');
         if (node.on) {
+            this.append(' ');
             this.visitNode(node.on);
         }
     }
+    visitOn(node) {
+        this.append('on ');
+        this.visitNode(node.on);
+    }
     visitRaw(node) {
         node.sqlFragments.forEach((sql, i) => {
             this.append(sql);
@@ -287,7 +295,7 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
     }
     visitCreateTable(node) {
         this.append('create table ');
-        if (node.modifier === 'IfNotExists') {
+        if (node.ifNotExists) {
             this.append('if not exists ');
         }
         this.visitNode(node.table);
@@ -299,23 +307,27 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
         this.visitNode(node.column);
         this.append(' ');
         this.visitNode(node.dataType);
+        if (node.generatedAlwaysAs) {
+            this.append(' ');
+            this.visitNode(node.generatedAlwaysAs);
+        }
         if (node.defaultTo) {
-            this.append(' default ');
+            this.append(' ');
             this.visitNode(node.defaultTo);
         }
-        if (!node.isNullable) {
+        if (!node.nullable) {
             this.append(' not null');
         }
-        if (node.isAutoIncrementing) {
-            this.append(' ');
-            this.append(this.getAutoIncrement());
-        }
-        if (node.isUnique) {
+        if (node.unique) {
             this.append(' unique');
         }
-        if (node.isPrimaryKey) {
+        if (node.primaryKey) {
             this.append(' primary key');
         }
+        if (node.autoIncrement) {
+            this.append(' ');
+            this.append(this.getAutoIncrement());
+        }
         if (node.references) {
             this.append(' ');
             this.visitNode(node.references);
@@ -345,7 +357,7 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
     }
     visitDropTable(node) {
         this.append('drop table ');
-        if (node.modifier === 'IfExists') {
+        if (node.ifExists) {
             this.append('if exists ');
         }
         this.visitNode(node.table);
@@ -467,7 +479,7 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
     }
     visitDropIndex(node) {
         this.append('drop index ');
-        if (node.modifier === 'IfExists') {
+        if (node.ifExists) {
             this.append('if exists ');
         }
         this.visitNode(node.name);
@@ -478,14 +490,14 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
     }
     visitCreateSchema(node) {
         this.append('create schema ');
-        if (node.modifier === 'IfNotExists') {
+        if (node.ifNotExists) {
             this.append('if not exists ');
         }
         this.visitNode(node.schema);
     }
     visitDropSchema(node) {
         this.append('drop schema ');
-        if (node.modifier === 'IfExists') {
+        if (node.ifExists) {
             this.append('if exists ');
         }
         this.visitNode(node.schema);
@@ -644,6 +656,53 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
         }
         this.visitNode(node.union);
     }
+    visitCreateView(node) {
+        this.append('create ');
+        if (node.orReplace) {
+            this.append('or replace ');
+        }
+        if (node.materialized) {
+            this.append('materialized ');
+        }
+        this.append('view ');
+        if (node.ifNotExists) {
+            this.append('if not exists ');
+        }
+        this.visitNode(node.name);
+        this.append(' ');
+        if (node.columns) {
+            this.append('(');
+            this.compileList(node.columns);
+            this.append(') ');
+        }
+        if (node.as) {
+            this.append('as ');
+            this.visitNode(node.as);
+        }
+    }
+    visitDropView(node) {
+        this.append('drop ');
+        if (node.materialized) {
+            this.append('materialized ');
+        }
+        this.append('view ');
+        if (node.ifExists) {
+            this.append('if exists ');
+        }
+        this.visitNode(node.name);
+    }
+    visitGeneratedAlwaysAs(node) {
+        this.append('generated always as (');
+        this.visitNode(node.expression);
+        this.append(')');
+        if (node.stored) {
+            this.append(' stored');
+        }
+    }
+    visitDefaultValue(node) {
+        this.append('default ');
+        this.visitNode(node.defaultValue);
+    }
     append(str) {
         this.#sql += str;
     }
@@ -684,17 +743,17 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
         }
     }
 }
-const SELECT_MODIFIER_SQL = {
+const SELECT_MODIFIER_SQL = freeze({
     ForKeyShare: 'for key share',
     ForNoKeyUpdate: 'for no key update',
     ForUpdate: 'for update',
     ForShare: 'for share',
     NoWait: 'nowait',
     SkipLocked: 'skip locked',
-};
-const JOIN_TYPE_SQL = {
+});
+const JOIN_TYPE_SQL = freeze({
     InnerJoin: 'inner join',
     LeftJoin: 'left join',
     RightJoin: 'right join',
     FullJoin: 'full join',
-};
+});

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

@@ -2,13 +2,15 @@ import { AlterTableNode } from '../operation-node/alter-table-node.js';
 import { CreateIndexNode } from '../operation-node/create-index-node.js';
 import { CreateSchemaNode } from '../operation-node/create-schema-node.js';
 import { CreateTableNode } from '../operation-node/create-table-node.js';
+import { CreateViewNode } from '../operation-node/create-view-node.js';
 import { DropIndexNode } from '../operation-node/drop-index-node.js';
 import { DropSchemaNode } from '../operation-node/drop-schema-node.js';
 import { DropTableNode } from '../operation-node/drop-table-node.js';
+import { DropViewNode } from '../operation-node/drop-view-node.js';
 import { QueryNode } from '../operation-node/query-node.js';
 import { RawNode } from '../operation-node/raw-node.js';
 import { CompiledQuery } from './compiled-query.js';
-export declare type RootOperationNode = QueryNode | CreateTableNode | CreateIndexNode | AlterTableNode | DropTableNode | DropIndexNode | CreateSchemaNode | DropSchemaNode | RawNode;
+export declare type RootOperationNode = QueryNode | CreateTableNode | CreateIndexNode | CreateSchemaNode | CreateViewNode | DropTableNode | DropIndexNode | DropSchemaNode | DropViewNode | AlterTableNode | RawNode;
 /**
  * a `QueryCompiler` compiles a query expressed as a tree of `OperationNodes` into SQL.
  */