kysely 0.8.1 → 0.9.3

package/README.md

@@ -4,7 +4,8 @@
 # [Kysely](https://koskimas.github.io/kysely/index.html)
 
 A type-safe and autocompletion-friendly typescript SQL query builder for node.js. Inspired by
-[knex](http://knexjs.org/). You can find an introduction to Kysely [here](https://www.jakso.me/blog/kysely-a-type-safe-sql-query-builder-for-typescript).
+[knex](http://knexjs.org/). [Here's](https://www.jakso.me/blog/kysely-a-type-safe-sql-query-builder-for-typescript)
+an introductory blog post for you.
 
 ![](https://github.com/koskimas/kysely/blob/master/assets/demo.gif)
 
@@ -25,7 +26,8 @@ type-safety! See the [DynamicModule](https://koskimas.github.io/kysely/classes/D
 for more info.
 
 Kysely is still young and some useful features are propably not yet implemented. If you start
-using Kysely and can't find something you'd want to use, please open an issue.
+using Kysely and can't find something you'd want to use, please open an issue or join our
+[discord server](https://discord.gg/C9aJ49mCra).
 
 # Table of contents
 
@@ -161,13 +163,15 @@ changes completely. Migrations need to be "frozen in time".
 The migrations can use the [Kysely.schema](https://koskimas.github.io/kysely/classes/SchemaModule.html)
 module to modify the schema. Migrations can also run normal queries to modify the data.
 
+### PostgreSQL migration example
+
 ```ts
 import { Kysely } from 'kysely'
 
 export async function up(db: Kysely<any>): Promise<void> {
   await db.schema
     .createTable('person')
-    .addColumn('id', 'integer', (col) => col.increments().primaryKey())
+    .addColumn('id', 'serial', (col) => col.primaryKey())
     .addColumn('first_name', 'varchar')
     .addColumn('last_name', 'varchar')
     .addColumn('gender', 'varchar(50)')
@@ -175,7 +179,7 @@ export async function up(db: Kysely<any>): Promise<void> {
 
   await db.schema
     .createTable('pet')
-    .addColumn('id', 'integer', (col) => col.increments().primaryKey())
+    .addColumn('id', 'serial', (col) => col.primaryKey())
     .addColumn('name', 'varchar', (col) => col.notNull().unique())
     .addColumn('owner_id', 'integer', (col) =>
       col.references('person.id').onDelete('cascade')
@@ -196,6 +200,45 @@ export async function down(db: Kysely<any>): Promise<void> {
 }
 ```
 
+### MySQL migration example
+
+```ts
+import { Kysely } from 'kysely'
+
+export async function up(db: Kysely<any>): Promise<void> {
+  await db.schema
+    .createTable('person')
+    .addColumn('id', 'integer', (col) => col.increments().primaryKey())
+    .addColumn('first_name', 'varchar')
+    .addColumn('last_name', 'varchar')
+    .addColumn('gender', 'varchar(50)')
+    .execute()
+
+  await db.schema
+    .createTable('pet')
+    .addColumn('id', 'integer', (col) => col.increments().primaryKey())
+    .addColumn('name', 'varchar', (col) => col.notNull().unique())
+    .addColumn('owner_id', 'integer')
+    .addColumn('species', 'varchar')
+    .addForeignKeyConstraint(
+      'pet_owner_id_fk', ['owner_id'], 'person', ['id'],
+      (cb) => cb.onDelete('cascade')
+    )
+    .execute()
+
+  await db.schema
+    .createIndex('pet_owner_id_index')
+    .on('pet')
+    .column('owner_id')
+    .execute()
+}
+
+export async function down(db: Kysely<any>): Promise<void> {
+  await db.schema.dropTable('pet').execute()
+  await db.schema.dropTable('person').execute()
+}
+```
+
 You can then use
 
 ```ts

package/dist/cjs/dialect/mysql/mysql-driver.js

@@ -107,13 +107,13 @@ class MysqlConnection {
     async executeQuery(compiledQuery) {
         const result = await this.#executeQuery(compiledQuery);
         if ((0, object_utils_js_1.isObject)(result) && 'insertId' in result && 'affectedRows' in result) {
-            if (result.insertId) {
+            if ((0, object_utils_js_1.isNumber)(result.insertId) && result.insertId > 0) {
                 return {
                     insertedPrimaryKey: result.insertId,
                     rows: [],
                 };
             }
-            else {
+            else if ((0, object_utils_js_1.isNumber)(result.affectedRows)) {
                 return {
                     numUpdatedOrDeletedRows: result.affectedRows,
                     rows: [],

package/dist/cjs/dialect/mysql/mysql-query-compiler.d.ts

@@ -1,7 +1,5 @@
-import { ColumnDefinitionNode } from '../../operation-node/column-definition-node.js';
 import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
 export declare class MysqlQueryCompiler extends DefaultQueryCompiler {
-    protected visitColumnDefinition(node: ColumnDefinitionNode): void;
     protected visitReturning(): void;
     protected getSql(): string;
     protected getCurrentParameterPlaceholder(): string;

package/dist/cjs/dialect/mysql/mysql-query-compiler.js

@@ -3,35 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MysqlQueryCompiler = void 0;
 const default_query_compiler_js_1 = require("../../query-compiler/default-query-compiler.js");
 class MysqlQueryCompiler extends default_query_compiler_js_1.DefaultQueryCompiler {
-    visitColumnDefinition(node) {
-        this.visitNode(node.column);
-        this.append(' ');
-        this.visitNode(node.dataType);
-        if (node.defaultTo) {
-            this.append(' default ');
-            this.visitNode(node.defaultTo);
-        }
-        if (!node.isNullable || node.isAutoIncrementing) {
-            this.append(' not null');
-        }
-        if (node.isAutoIncrementing) {
-            this.append(' auto_increment');
-        }
-        if (node.isUnique) {
-            this.append(' unique');
-        }
-        if (node.isPrimaryKey) {
-            this.append(' primary key');
-        }
-        if (node.references) {
-            this.append(' ');
-            this.visitNode(node.references);
-        }
-        if (node.check) {
-            this.append(' ');
-            this.visitNode(node.check);
-        }
-    }
     visitReturning() {
         // Do nothing.
     }

package/dist/cjs/operation-node/create-schema-node.d.ts

@@ -13,5 +13,5 @@ export interface CreateSchemaNode extends OperationNode {
 export declare const CreateSchemaNode: Readonly<{
     is(node: OperationNode): node is CreateSchemaNode;
     create(schema: string, params?: CreateSchemaNodeParams | undefined): CreateSchemaNode;
-    cloneWithModifier(createSchema: CreateSchemaNode, modifier: CreateSchemaNodeModifier): CreateSchemaNode;
+    cloneWith(createSchema: CreateSchemaNode, params: CreateSchemaNodeParams): CreateSchemaNode;
 }>;

package/dist/cjs/operation-node/create-schema-node.js

@@ -17,10 +17,10 @@ exports.CreateSchemaNode = (0, object_utils_js_1.freeze)({
             ...params,
         });
     },
-    cloneWithModifier(createSchema, modifier) {
+    cloneWith(createSchema, params) {
         return (0, object_utils_js_1.freeze)({
             ...createSchema,
-            modifier,
+            ...params,
         });
     },
 });

package/dist/cjs/operation-node/create-table-node.d.ts

@@ -1,6 +1,5 @@
 import { OperationNode } from './operation-node.js';
 import { TableNode } from './table-node.js';
-import { ForeignKeyConstraintNode } from './foreign-key-constraint-node.js';
 import { ConstraintNode } from './constraint-node.js';
 import { ColumnDefinitionNode } from './column-definition-node.js';
 export declare type CreateTableNodeModifier = 'IfNotExists';
@@ -19,8 +18,5 @@ export declare const CreateTableNode: Readonly<{
     create(table: TableNode): CreateTableNode;
     cloneWithColumn(createTable: CreateTableNode, column: ColumnDefinitionNode): CreateTableNode;
     cloneWithModifier(createTable: CreateTableNode, modifier: CreateTableNodeModifier): CreateTableNode;
-    cloneWithPrimaryKeyConstraint(createTable: CreateTableNode, constraintName: string, columns: string[]): CreateTableNode;
-    cloneWithUniqueConstraint(createTable: CreateTableNode, constraintName: string, columns: string[]): CreateTableNode;
-    cloneWithCheckConstraint(createTable: CreateTableNode, constraintName: string, sql: string): CreateTableNode;
-    cloneWithForeignKeyConstraint(createTable: CreateTableNode, constraint: ForeignKeyConstraintNode): CreateTableNode;
+    cloneWithConstraint(createTable: CreateTableNode, constraint: ConstraintNode): CreateTableNode;
 }>;

package/dist/cjs/operation-node/create-table-node.js

@@ -2,9 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CreateTableNode = void 0;
 const object_utils_js_1 = require("../util/object-utils.js");
-const check_constraint_node_js_1 = require("./check-constraint-node.js");
-const primary_constraint_node_js_1 = require("./primary-constraint-node.js");
-const unique_constraint_node_js_1 = require("./unique-constraint-node.js");
 /**
  * @internal
  */
@@ -31,34 +28,7 @@ exports.CreateTableNode = (0, object_utils_js_1.freeze)({
             modifier,
         });
     },
-    cloneWithPrimaryKeyConstraint(createTable, constraintName, columns) {
-        const constraint = primary_constraint_node_js_1.PrimaryConstraintNode.create(columns, constraintName);
-        return (0, object_utils_js_1.freeze)({
-            ...createTable,
-            constraints: createTable.constraints
-                ? (0, object_utils_js_1.freeze)([...createTable.constraints, constraint])
-                : (0, object_utils_js_1.freeze)([constraint]),
-        });
-    },
-    cloneWithUniqueConstraint(createTable, constraintName, columns) {
-        const constraint = unique_constraint_node_js_1.UniqueConstraintNode.create(columns, constraintName);
-        return (0, object_utils_js_1.freeze)({
-            ...createTable,
-            constraints: createTable.constraints
-                ? (0, object_utils_js_1.freeze)([...createTable.constraints, constraint])
-                : (0, object_utils_js_1.freeze)([constraint]),
-        });
-    },
-    cloneWithCheckConstraint(createTable, constraintName, sql) {
-        const constraint = check_constraint_node_js_1.CheckConstraintNode.create(sql, constraintName);
-        return (0, object_utils_js_1.freeze)({
-            ...createTable,
-            constraints: createTable.constraints
-                ? (0, object_utils_js_1.freeze)([...createTable.constraints, constraint])
-                : (0, object_utils_js_1.freeze)([constraint]),
-        });
-    },
-    cloneWithForeignKeyConstraint(createTable, constraint) {
+    cloneWithConstraint(createTable, constraint) {
         return (0, object_utils_js_1.freeze)({
             ...createTable,
             constraints: createTable.constraints

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

@@ -21,5 +21,6 @@ export declare const JoinNode: Readonly<{
     is(node: OperationNode): node is JoinNode;
     create(joinType: JoinType, table: JoinTableNode): JoinNode;
     createWithOn(joinType: JoinType, table: JoinTableNode, on: JoinNodeOnNode): JoinNode;
-    cloneWithOn(joinNode: JoinNode, op: 'And' | 'Or', on: JoinNodeOnNode): JoinNode;
+    cloneWithOn(joinNode: JoinNode, on: JoinNodeOnNode): JoinNode;
+    cloneWithOrOn(joinNode: JoinNode, on: JoinNodeOnNode): JoinNode;
 }>;

package/dist/cjs/operation-node/join-node.js

@@ -27,14 +27,16 @@ exports.JoinNode = (0, object_utils_js_1.freeze)({
             on,
         });
     },
-    cloneWithOn(joinNode, op, on) {
+    cloneWithOn(joinNode, on) {
         return (0, object_utils_js_1.freeze)({
             ...joinNode,
-            on: joinNode.on
-                ? op === 'And'
-                    ? and_node_js_1.AndNode.create(joinNode.on, on)
-                    : or_node_js_1.OrNode.create(joinNode.on, on)
-                : on,
+            on: joinNode.on ? and_node_js_1.AndNode.create(joinNode.on, on) : on,
+        });
+    },
+    cloneWithOrOn(joinNode, on) {
+        return (0, object_utils_js_1.freeze)({
+            ...joinNode,
+            on: joinNode.on ? or_node_js_1.OrNode.create(joinNode.on, on) : on,
         });
     },
 });

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

@@ -2,4 +2,4 @@ import { OperationNode } from './operation-node.js';
 export interface OperationNodeSource {
     toOperationNode(): OperationNode;
 }
-export declare function isOperationNodeSource(obj: any): obj is OperationNodeSource;
+export declare function isOperationNodeSource(obj: unknown): obj is OperationNodeSource;

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

@@ -57,6 +57,7 @@ import { ForeignKeyConstraintNode } from './foreign-key-constraint-node.js';
 import { ColumnDefinitionNode } from './column-definition-node.js';
 import { ModifyColumnNode } from './modify-column-node.js';
 import { OnDuplicateKeyNode } from './on-duplicate-key-node.js';
+import { UnionNode } from './union-node.js';
 /**
  * Transforms an operation node tree into another one.
  *
@@ -129,6 +130,7 @@ export declare class OperationNodeTransformer {
     protected transformPrimaryKeyConstraint(node: PrimaryKeyConstraintNode): PrimaryKeyConstraintNode;
     protected transformUniqueConstraint(node: UniqueConstraintNode): UniqueConstraintNode;
     protected transformForeignKeyConstraint(node: ForeignKeyConstraintNode): ForeignKeyConstraintNode;
+    protected transformUnion(node: UnionNode): UnionNode;
     protected transformReferences(node: ReferencesNode): ReferencesNode;
     protected transformCheckConstraint(node: CheckConstraintNode): CheckConstraintNode;
     protected transformWith(node: WithNode): WithNode;

package/dist/cjs/operation-node/operation-node-transformer.js

@@ -92,6 +92,7 @@ class OperationNodeTransformer {
         AddConstraintNode: this.transformAddConstraint.bind(this),
         DropConstraintNode: this.transformDropConstraint.bind(this),
         ForeignKeyConstraintNode: this.transformForeignKeyConstraint.bind(this),
+        UnionNode: this.transformUnion.bind(this),
     };
     transformNode = (node) => {
         if (!node) {
@@ -124,6 +125,7 @@ class OperationNodeTransformer {
             offset: this.transformNode(node.offset),
             with: this.transformNode(node.with),
             having: this.transformNode(node.having),
+            union: this.transformNodeList(node.union),
         };
     }
     transformSelection(node) {
@@ -403,6 +405,13 @@ class OperationNodeTransformer {
             onUpdate: node.onUpdate,
         };
     }
+    transformUnion(node) {
+        return {
+            kind: 'UnionNode',
+            union: this.transformNode(node.union),
+            all: node.all,
+        };
+    }
     transformReferences(node) {
         return {
             kind: 'ReferencesNode',
@@ -456,11 +465,12 @@ class OperationNodeTransformer {
             kind: 'AlterTableNode',
             table: this.transformNode(node.table),
             renameTo: this.transformNode(node.renameTo),
-            renameColumn: this.transformNode(node.renameColumn),
             setSchema: this.transformNode(node.setSchema),
+            renameColumn: this.transformNode(node.renameColumn),
             addColumn: this.transformNode(node.addColumn),
             dropColumn: this.transformNode(node.dropColumn),
             alterColumn: this.transformNode(node.alterColumn),
+            modifyColumn: this.transformNode(node.modifyColumn),
             addConstraint: this.transformNode(node.addConstraint),
             dropConstraint: this.transformNode(node.dropConstraint),
         };

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

@@ -57,66 +57,68 @@ import { ForeignKeyConstraintNode } from './foreign-key-constraint-node.js';
 import { ColumnDefinitionNode } from './column-definition-node.js';
 import { ModifyColumnNode } from './modify-column-node.js';
 import { OnDuplicateKeyNode } from './on-duplicate-key-node.js';
-export declare class OperationNodeVisitor {
+import { UnionNode } from './union-node.js';
+export declare abstract class OperationNodeVisitor {
     #private;
     protected readonly nodeStack: OperationNode[];
     protected readonly visitNode: (node: OperationNode) => void;
-    protected visitSelectQuery(node: SelectQueryNode): void;
-    protected visitSelection(node: SelectionNode): void;
-    protected visitColumn(node: ColumnNode): void;
-    protected visitAlias(node: AliasNode): void;
-    protected visitTable(node: TableNode): void;
-    protected visitFrom(node: FromNode): void;
-    protected visitReference(node: ReferenceNode): void;
-    protected visitFilter(node: FilterNode): void;
-    protected visitAnd(node: AndNode): void;
-    protected visitOr(node: OrNode): void;
-    protected visitValueList(node: ValueListNode): void;
-    protected visitParens(node: ParensNode): void;
-    protected visitJoin(node: JoinNode): void;
-    protected visitRaw(node: RawNode): void;
-    protected visitWhere(node: WhereNode): void;
-    protected visitInsertQuery(node: InsertQueryNode): void;
-    protected visitDeleteQuery(node: DeleteQueryNode): void;
-    protected visitReturning(node: ReturningNode): void;
-    protected visitCreateTable(node: CreateTableNode): void;
-    protected visitAddColumn(node: AddColumnNode): void;
-    protected visitColumnDefinition(node: ColumnDefinitionNode): void;
-    protected visitDropTable(node: DropTableNode): void;
-    protected visitOrderBy(node: OrderByNode): void;
-    protected visitOrderByItem(node: OrderByItemNode): void;
-    protected visitGroupBy(node: GroupByNode): void;
-    protected visitGroupByItem(node: GroupByItemNode): void;
-    protected visitUpdateQuery(node: UpdateQueryNode): void;
-    protected visitColumnUpdate(node: ColumnUpdateNode): void;
-    protected visitLimit(node: LimitNode): void;
-    protected visitOffset(node: OffsetNode): void;
-    protected visitOnConflict(node: OnConflictNode): void;
-    protected visitOnDuplicateKey(node: OnDuplicateKeyNode): void;
-    protected visitCreateIndex(node: CreateIndexNode): void;
-    protected visitList(node: ListNode): void;
-    protected visitDropIndex(node: DropIndexNode): void;
-    protected visitPrimaryKeyConstraint(node: PrimaryKeyConstraintNode): void;
-    protected visitUniqueConstraint(node: UniqueConstraintNode): void;
-    protected visitReferences(node: ReferencesNode): void;
-    protected visitCheckConstraint(node: CheckConstraintNode): void;
-    protected visitWith(node: WithNode): void;
-    protected visitCommonTableExpression(node: CommonTableExpressionNode): void;
-    protected visitHaving(node: HavingNode): void;
-    protected visitCreateSchema(node: CreateSchemaNode): void;
-    protected visitDropSchema(node: DropSchemaNode): void;
-    protected visitAlterTable(node: AlterTableNode): void;
-    protected visitDropColumn(node: DropColumnNode): void;
-    protected visitRenameColumn(node: RenameColumnNode): void;
-    protected visitAlterColumn(node: AlterColumnNode): void;
-    protected visitModifyColumn(node: ModifyColumnNode): void;
-    protected visitAddConstraint(node: AddConstraintNode): void;
-    protected visitDropConstraint(node: DropConstraintNode): void;
-    protected visitForeignKeyConstraint(node: ForeignKeyConstraintNode): void;
-    protected visitDataType(node: DataTypeNode): void;
-    protected visitSelectAll(_: SelectAllNode): void;
-    protected visitIdentifier(_: IdentifierNode): void;
-    protected visitValue(_: ValueNode): void;
-    protected visitPrimitiveValueList(_: PrimitiveValueListNode): void;
-    protected visitOperator(node: OperatorNode): void;
+    protected abstract visitSelectQuery(node: SelectQueryNode): void;
+    protected abstract visitSelection(node: SelectionNode): void;
+    protected abstract visitColumn(node: ColumnNode): void;
+    protected abstract visitAlias(node: AliasNode): void;
+    protected abstract visitTable(node: TableNode): void;
+    protected abstract visitFrom(node: FromNode): void;
+    protected abstract visitReference(node: ReferenceNode): void;
+    protected abstract visitFilter(node: FilterNode): void;
+    protected abstract visitAnd(node: AndNode): void;
+    protected abstract visitOr(node: OrNode): void;
+    protected abstract visitValueList(node: ValueListNode): void;
+    protected abstract visitParens(node: ParensNode): void;
+    protected abstract visitJoin(node: JoinNode): void;
+    protected abstract visitRaw(node: RawNode): void;
+    protected abstract visitWhere(node: WhereNode): void;
+    protected abstract visitInsertQuery(node: InsertQueryNode): void;
+    protected abstract visitDeleteQuery(node: DeleteQueryNode): void;
+    protected abstract visitReturning(node: ReturningNode): void;
+    protected abstract visitCreateTable(node: CreateTableNode): void;
+    protected abstract visitAddColumn(node: AddColumnNode): void;
+    protected abstract visitColumnDefinition(node: ColumnDefinitionNode): void;
+    protected abstract visitDropTable(node: DropTableNode): void;
+    protected abstract visitOrderBy(node: OrderByNode): void;
+    protected abstract visitOrderByItem(node: OrderByItemNode): void;
+    protected abstract visitGroupBy(node: GroupByNode): void;
+    protected abstract visitGroupByItem(node: GroupByItemNode): void;
+    protected abstract visitUpdateQuery(node: UpdateQueryNode): void;
+    protected abstract visitColumnUpdate(node: ColumnUpdateNode): void;
+    protected abstract visitLimit(node: LimitNode): void;
+    protected abstract visitOffset(node: OffsetNode): void;
+    protected abstract visitOnConflict(node: OnConflictNode): void;
+    protected abstract visitOnDuplicateKey(node: OnDuplicateKeyNode): void;
+    protected abstract visitCreateIndex(node: CreateIndexNode): void;
+    protected abstract visitDropIndex(node: DropIndexNode): void;
+    protected abstract visitList(node: ListNode): void;
+    protected abstract visitPrimaryKeyConstraint(node: PrimaryKeyConstraintNode): void;
+    protected abstract visitUniqueConstraint(node: UniqueConstraintNode): void;
+    protected abstract visitReferences(node: ReferencesNode): void;
+    protected abstract visitCheckConstraint(node: CheckConstraintNode): void;
+    protected abstract visitWith(node: WithNode): void;
+    protected abstract visitCommonTableExpression(node: CommonTableExpressionNode): void;
+    protected abstract visitHaving(node: HavingNode): void;
+    protected abstract visitCreateSchema(node: CreateSchemaNode): void;
+    protected abstract visitDropSchema(node: DropSchemaNode): void;
+    protected abstract visitAlterTable(node: AlterTableNode): void;
+    protected abstract visitDropColumn(node: DropColumnNode): void;
+    protected abstract visitRenameColumn(node: RenameColumnNode): void;
+    protected abstract visitAlterColumn(node: AlterColumnNode): void;
+    protected abstract visitModifyColumn(node: ModifyColumnNode): void;
+    protected abstract visitAddConstraint(node: AddConstraintNode): void;
+    protected abstract visitDropConstraint(node: DropConstraintNode): void;
+    protected abstract visitForeignKeyConstraint(node: ForeignKeyConstraintNode): void;
+    protected abstract visitUnion(node: UnionNode): void;
+    protected abstract visitDataType(node: DataTypeNode): void;
+    protected abstract visitSelectAll(_: SelectAllNode): void;
+    protected abstract visitIdentifier(_: IdentifierNode): void;
+    protected abstract visitValue(_: ValueNode): void;
+    protected abstract visitPrimitiveValueList(_: PrimitiveValueListNode): void;
+    protected abstract visitOperator(node: OperatorNode): void;
 }