kysely 0.27.1 → 0.27.3

package/dist/cjs/schema/column-definition-builder.js

@@ -26,6 +26,16 @@ class ColumnDefinitionBuilder {
     autoIncrement() {
         return new ColumnDefinitionBuilder(column_definition_node_js_1.ColumnDefinitionNode.cloneWith(this.#node, { autoIncrement: true }));
     }
+    /**
+     * Makes the column an identity column.
+     *
+     * This only works on some dialects like MS SQL Server (MSSQL).
+     *
+     * For PostgreSQL's `generated always as identity` use {@link generatedAlwaysAsIdentity}.
+     */
+    identity() {
+        return new ColumnDefinitionBuilder(column_definition_node_js_1.ColumnDefinitionNode.cloneWith(this.#node, { identity: true }));
+    }
     /**
      * Makes the column the primary key.
      *
@@ -193,7 +203,11 @@ class ColumnDefinitionBuilder {
         }));
     }
     /**
-     * Adds the `generated always as identity` specifier on supported dialects.
+     * Adds the `generated always as identity` specifier.
+     *
+     * This only works on some dialects like PostgreSQL.
+     *
+     * For MS SQL Server (MSSQL)'s identity column use {@link identity}.
      */
     generatedAlwaysAsIdentity() {
         return new ColumnDefinitionBuilder(column_definition_node_js_1.ColumnDefinitionNode.cloneWith(this.#node, {

package/dist/cjs/util/infer-result.d.ts

@@ -1,5 +1,6 @@
 import { DeleteResult } from '../query-builder/delete-result.js';
 import { InsertResult } from '../query-builder/insert-result.js';
+import { MergeResult } from '../query-builder/merge-result.js';
 import { UpdateResult } from '../query-builder/update-result.js';
 import { CompiledQuery } from '../query-compiler/compiled-query.js';
 import { Compilable } from './compilable.js';
@@ -43,5 +44,5 @@ import { Simplify } from './type-utils.js';
  * ```
  */
 export type InferResult<C extends Compilable<any> | CompiledQuery<any>> = C extends Compilable<infer O> ? ResolveResult<O> : C extends CompiledQuery<infer O> ? ResolveResult<O> : never;
-type ResolveResult<O> = O extends InsertResult | UpdateResult | DeleteResult ? O : Simplify<O>[];
+type ResolveResult<O> = O extends InsertResult | UpdateResult | DeleteResult | MergeResult ? O : Simplify<O>[];
 export {};

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

@@ -2,6 +2,7 @@ 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 { KyselyTypeError } from './type-error.js';
+import { MergeResult } from '../query-builder/merge-result.js';
 /**
  * Given a database type and a union of table names in that db, returns
  * a union type with all possible column names.
@@ -88,8 +89,8 @@ export type AnyAliasedColumnWithTable<DB, TB extends keyof DB> = `${AnyColumnWit
  * Extracts the item type of an array.
  */
 export type ArrayItemType<T> = T extends ReadonlyArray<infer I> ? I : never;
-export type SimplifySingleResult<O> = O extends InsertResult ? O : O extends DeleteResult ? O : O extends UpdateResult ? O : Simplify<O> | undefined;
-export type SimplifyResult<O> = O extends InsertResult ? O : O extends DeleteResult ? O : O extends UpdateResult ? O : Simplify<O>;
+export type SimplifySingleResult<O> = O extends InsertResult ? O : O extends DeleteResult ? O : O extends UpdateResult ? O : O extends MergeResult ? O : Simplify<O> | undefined;
+export type SimplifyResult<O> = O extends InsertResult ? O : O extends DeleteResult ? O : O extends UpdateResult ? O : O extends MergeResult ? O : Simplify<O>;
 export type Simplify<T> = DrainOuterGeneric<{
     [K in keyof T]: T[K];
 } & {}>;

package/dist/esm/dialect/database-introspector.d.ts

@@ -58,4 +58,5 @@ export interface ColumnMetadata {
     readonly isAutoIncrementing: boolean;
     readonly isNullable: boolean;
     readonly hasDefaultValue: boolean;
+    readonly comment?: string;
 }

package/dist/esm/dialect/mssql/mssql-introspector.js

@@ -14,8 +14,12 @@ export class MssqlIntrospector {
             .selectFrom('sys.tables as tables')
             .leftJoin('sys.schemas as table_schemas', 'table_schemas.schema_id', 'tables.schema_id')
             .innerJoin('sys.columns as columns', 'columns.object_id', 'tables.object_id')
-            .innerJoin('sys.types as types', 'types.system_type_id', 'columns.system_type_id')
+            .innerJoin('sys.types as types', 'types.user_type_id', 'columns.user_type_id')
             .leftJoin('sys.schemas as type_schemas', 'type_schemas.schema_id', 'types.schema_id')
+            .leftJoin('sys.extended_properties as comments', (join) => join
+            .onRef('comments.major_id', '=', 'tables.object_id')
+            .onRef('comments.minor_id', '=', 'columns.column_id')
+            .on('comments.name', '=', 'MS_Description'))
             .$if(!options.withInternalKyselyTables, (qb) => qb
             .where('tables.name', '!=', DEFAULT_MIGRATION_TABLE)
             .where('tables.name', '!=', DEFAULT_MIGRATION_LOCK_TABLE))
@@ -36,13 +40,18 @@ export class MssqlIntrospector {
             'types.is_nullable as type_is_nullable',
             'types.name as type_name',
             'type_schemas.name as type_schema_name',
+            'comments.value as column_comment',
         ])
             .unionAll(this.#db
             .selectFrom('sys.views as views')
             .leftJoin('sys.schemas as view_schemas', 'view_schemas.schema_id', 'views.schema_id')
             .innerJoin('sys.columns as columns', 'columns.object_id', 'views.object_id')
-            .innerJoin('sys.types as types', 'types.system_type_id', 'columns.system_type_id')
+            .innerJoin('sys.types as types', 'types.user_type_id', 'columns.user_type_id')
             .leftJoin('sys.schemas as type_schemas', 'type_schemas.schema_id', 'types.schema_id')
+            .leftJoin('sys.extended_properties as comments', (join) => join
+            .onRef('comments.major_id', '=', 'views.object_id')
+            .onRef('comments.minor_id', '=', 'columns.column_id')
+            .on('comments.name', '=', 'MS_Description'))
             .select([
             'views.name as table_name',
             'views.type as table_type',
@@ -57,6 +66,7 @@ export class MssqlIntrospector {
             'types.is_nullable as type_is_nullable',
             'types.name as type_name',
             'type_schemas.name as type_schema_name',
+            'comments.value as column_comment',
         ]))
             .orderBy('table_schema_name')
             .orderBy('table_name')
@@ -84,6 +94,7 @@ export class MssqlIntrospector {
                 isAutoIncrementing: rawColumn.column_is_identity,
                 isNullable: rawColumn.column_is_nullable && rawColumn.type_is_nullable,
                 name: rawColumn.column_name,
+                comment: rawColumn.column_comment ?? undefined,
             }));
         }
         return Object.values(tableDictionary);

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

@@ -1,11 +1,15 @@
 import { AddColumnNode } from '../../operation-node/add-column-node.js';
 import { AlterTableColumnAlterationNode } from '../../operation-node/alter-table-node.js';
 import { DropColumnNode } from '../../operation-node/drop-column-node.js';
+import { OffsetNode } from '../../operation-node/offset-node.js';
+import { MergeQueryNode } from '../../operation-node/merge-query-node.js';
 import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
 export declare class MssqlQueryCompiler extends DefaultQueryCompiler {
     protected getCurrentParameterPlaceholder(): string;
+    protected visitOffset(node: OffsetNode): void;
     protected compileColumnAlterations(columnAlterations: readonly AlterTableColumnAlterationNode[]): void;
     protected visitAddColumn(node: AddColumnNode): void;
     protected visitDropColumn(node: DropColumnNode): void;
+    protected visitMergeQuery(node: MergeQueryNode): void;
     protected announcesNewColumnDataType(): boolean;
 }

package/dist/esm/dialect/mssql/mssql-query-compiler.js

@@ -4,6 +4,10 @@ export class MssqlQueryCompiler extends DefaultQueryCompiler {
     getCurrentParameterPlaceholder() {
         return `@${this.numParameters}`;
     }
+    visitOffset(node) {
+        super.visitOffset(node);
+        this.append(' rows');
+    }
     // mssql allows multi-column alterations in a single statement,
     // but you can only use the command keyword/s once.
     // it also doesn't support multiple kinds of commands in the same
@@ -55,6 +59,10 @@ export class MssqlQueryCompiler extends DefaultQueryCompiler {
     visitDropColumn(node) {
         this.visitNode(node.column);
     }
+    visitMergeQuery(node) {
+        super.visitMergeQuery(node);
+        this.append(';');
+    }
     announcesNewColumnDataType() {
         return false;
     }

package/dist/esm/dialect/mysql/mysql-introspector.js

@@ -31,6 +31,7 @@ export class MysqlIntrospector {
             'columns.IS_NULLABLE',
             'columns.DATA_TYPE',
             'columns.EXTRA',
+            'columns.COLUMN_COMMENT',
         ])
             .where('columns.TABLE_SCHEMA', '=', sql `database()`)
             .orderBy('columns.TABLE_NAME')
@@ -67,6 +68,7 @@ export class MysqlIntrospector {
                 isNullable: it.IS_NULLABLE === 'YES',
                 isAutoIncrementing: it.EXTRA.toLowerCase().includes('auto_increment'),
                 hasDefaultValue: it.COLUMN_DEFAULT !== null,
+                comment: it.COLUMN_COMMENT === '' ? undefined : it.COLUMN_COMMENT,
             }));
             return tables;
         }, []);

package/dist/esm/dialect/postgres/postgres-dialect-config.d.ts

@@ -52,7 +52,7 @@ export interface PostgresCursor<T> {
 }
 export type PostgresCursorConstructor = new <T>(sql: string, parameters: unknown[]) => PostgresCursor<T>;
 export interface PostgresQueryResult<R> {
-    command: 'UPDATE' | 'DELETE' | 'INSERT' | 'SELECT';
+    command: 'UPDATE' | 'DELETE' | 'INSERT' | 'SELECT' | 'MERGE';
     rowCount: number;
     rows: R[];
 }

package/dist/esm/dialect/postgres/postgres-driver.js

@@ -71,7 +71,8 @@ class PostgresConnection {
             ]);
             if (result.command === 'INSERT' ||
                 result.command === 'UPDATE' ||
-                result.command === 'DELETE') {
+                result.command === 'DELETE' ||
+                result.command === 'MERGE') {
                 const numAffectedRows = BigInt(result.rowCount);
                 return {
                     // TODO: remove.

package/dist/esm/dialect/postgres/postgres-introspector.js

@@ -36,6 +36,7 @@ export class PostgresIntrospector {
             'ns.nspname as schema',
             'typ.typname as type',
             'dtns.nspname as type_schema',
+            sql `col_description(a.attrelid, a.attnum)`.as('column_description'),
             // Detect if the column is auto incrementing by finding the sequence
             // that is created for `serial` and `bigserial` columns.
             this.#db
@@ -90,6 +91,7 @@ export class PostgresIntrospector {
                 isNullable: !it.not_null,
                 isAutoIncrementing: !!it.auto_incrementing,
                 hasDefaultValue: it.has_default,
+                comment: it.column_description ?? undefined,
             }));
             return tables;
         }, []);

package/dist/esm/dialect/sqlite/sqlite-introspector.js

@@ -61,6 +61,7 @@ export class SqliteIntrospector {
                 isNullable: !col.notnull,
                 isAutoIncrementing: col.name === autoIncrementCol,
                 hasDefaultValue: col.dflt_value != null,
+                comment: undefined,
             })),
         };
     }

package/dist/esm/driver/database-connection.d.ts

@@ -14,7 +14,7 @@ export interface QueryResult<O> {
      */
     readonly numUpdatedOrDeletedRows?: bigint;
     /**
-     * This is defined for insert, update and delete queries and contains
+     * This is defined for insert, update, delete and merge queries and contains
      * the number of rows the query inserted/updated/deleted.
      */
     readonly numAffectedRows?: bigint;

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

@@ -15,6 +15,7 @@ import { OperandExpression } from '../parser/expression-parser.js';
 import { RefTuple2, RefTuple3, RefTuple4, RefTuple5, ValTuple2, ValTuple3, ValTuple4, ValTuple5 } from '../parser/tuple-parser.js';
 import { Selectable } from '../util/column-type.js';
 import { KyselyTypeError } from '../util/type-error.js';
+import { DataTypeExpression } from '../parser/data-type-parser.js';
 export interface ExpressionBuilder<DB, TB extends keyof DB> {
     /**
      * Creates a binary expression.
@@ -194,7 +195,7 @@ export interface ExpressionBuilder<DB, TB extends keyof DB> {
     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, 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>, {}>;
     /**
      * Creates a `case` statement/operator.
@@ -218,7 +219,7 @@ export interface ExpressionBuilder<DB, TB extends keyof DB> {
      *       .when('gender', '=', 'female')
      *       .then(
      *         eb
-     *           .case('martialStatus')
+     *           .case('maritalStatus')
      *           .when('single')
      *           .then('Ms.')
      *           .else('Mrs.')
@@ -238,7 +239,7 @@ export interface ExpressionBuilder<DB, TB extends keyof DB> {
      *   case
      *     when "gender" = $1 then $2
      *     when "gender" = $3 then
-     *       case "martialStatus"
+     *       case "maritalStatus"
      *         when $4 then $5
      *         else $6
      *       end
@@ -775,7 +776,7 @@ export interface ExpressionBuilder<DB, TB extends keyof DB> {
      * ```ts
      * db.selectFrom('person')
      *   .selectAll('person')
-     *   .where((eb) => parens(
+     *   .where((eb) => eb.parens(
      *     eb('age', '=', 1).or('age', '=', 2))
      *   ).and(
      *     eb('first_name', '=', 'Jennifer').or('first_name', '=', 'Arnold')
@@ -792,6 +793,31 @@ export interface ExpressionBuilder<DB, TB extends keyof DB> {
      */
     parens<RE extends ReferenceExpression<DB, TB>, OP extends BinaryOperatorExpression, VE extends OperandValueExpressionOrList<DB, TB, RE>>(lhs: RE, op: OP, rhs: VE): ExpressionWrapper<DB, TB, OP extends ComparisonOperator ? SqlBool : ExtractTypeFromReferenceExpression<DB, TB, RE>>;
     parens<T>(expr: Expression<T>): ExpressionWrapper<DB, TB, T>;
+    /**
+     * Creates a `cast(expr as dataType)` expression.
+     *
+     * Since Kysely can't know the mapping between javascript and database types,
+     * you need to provide both explicitly.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .select((eb) => [
+     *     'id',
+     *     'first_name',
+     *     eb.cast<number>('age', 'integer').as('age')
+     *   ])
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * select cast("age" as integer) as "age"
+     * from "person"
+     * ```
+     */
+    cast<T, RE extends ReferenceExpression<DB, TB> = ReferenceExpression<DB, TB>>(expr: RE, dataType: DataTypeExpression): ExpressionWrapper<DB, TB, T>;
     /**
      * See {@link QueryCreator.withSchema}
      *

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

@@ -21,6 +21,8 @@ import { BinaryOperationNode } from '../operation-node/binary-operation-node.js'
 import { AndNode } from '../operation-node/and-node.js';
 import { TupleNode } from '../operation-node/tuple-node.js';
 import { JSONPathNode } from '../operation-node/json-path-node.js';
+import { parseDataTypeExpression, } from '../parser/data-type-parser.js';
+import { CastNode } from '../operation-node/cast-node.js';
 export function createExpressionBuilder(executor = NOOP_QUERY_EXECUTOR) {
     function binary(lhs, op, rhs) {
         return new ExpressionWrapper(parseValueBinaryOperation(lhs, op, rhs));
@@ -107,6 +109,9 @@ export function createExpressionBuilder(executor = NOOP_QUERY_EXECUTOR) {
                 return new ExpressionWrapper(ParensNode.create(node));
             }
         },
+        cast(expr, dataType) {
+            return new ExpressionWrapper(CastNode.create(parseReferenceExpression(expr), parseDataTypeExpression(dataType)));
+        },
         withSchema(schema) {
             return createExpressionBuilder(executor.withPluginAtFront(new WithSchemaPlugin(schema)));
         },

package/dist/esm/index.d.ts

@@ -20,6 +20,8 @@ export * from './query-builder/on-conflict-builder.js';
 export * from './query-builder/aggregate-function-builder.js';
 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 './raw-builder/raw-builder.js';
 export * from './raw-builder/sql.js';
 export * from './query-executor/query-executor.js';
@@ -177,6 +179,10 @@ export * from './operation-node/json-path-leg-node.js';
 export * from './operation-node/json-path-node.js';
 export * from './operation-node/json-operator-chain-node.js';
 export * from './operation-node/tuple-node.js';
+export * from './operation-node/merge-query-node.js';
+export * from './operation-node/matched-node.js';
+export * from './operation-node/fetch-node.js';
+export * from './operation-node/top-node.js';
 export * from './util/column-type.js';
 export * from './util/compilable.js';
 export * from './util/explainable.js';
@@ -188,7 +194,7 @@ export { logOnce } from './util/log-once.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';
-export { TableExpression, TableExpressionOrList, } from './parser/table-parser.js';
+export { SimpleTableReference, TableExpression, TableExpressionOrList, } from './parser/table-parser.js';
 export { JoinReferenceExpression, JoinCallbackExpression, } from './parser/join-parser.js';
 export { InsertObject } from './parser/insert-values-parser.js';
 export { UpdateObject } from './parser/update-set-parser.js';

package/dist/esm/index.js

@@ -21,6 +21,8 @@ export * from './query-builder/on-conflict-builder.js';
 export * from './query-builder/aggregate-function-builder.js';
 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 './raw-builder/raw-builder.js';
 export * from './raw-builder/sql.js';
 export * from './query-executor/query-executor.js';
@@ -178,6 +180,10 @@ export * from './operation-node/json-path-leg-node.js';
 export * from './operation-node/json-path-node.js';
 export * from './operation-node/json-operator-chain-node.js';
 export * from './operation-node/tuple-node.js';
+export * from './operation-node/merge-query-node.js';
+export * from './operation-node/matched-node.js';
+export * from './operation-node/fetch-node.js';
+export * from './operation-node/top-node.js';
 export * from './util/column-type.js';
 export * from './util/compilable.js';
 export * from './util/explainable.js';

package/dist/esm/migration/migrator.d.ts

@@ -1,6 +1,7 @@
 import { Kysely } from '../kysely.js';
 export declare const DEFAULT_MIGRATION_TABLE = "kysely_migration";
 export declare const DEFAULT_MIGRATION_LOCK_TABLE = "kysely_migration_lock";
+export declare const DEFAULT_ALLOW_UNORDERED_MIGRATIONS = false;
 export declare const MIGRATION_LOCK_ID = "migration_lock";
 export declare const NO_MIGRATIONS: NoMigrations;
 export interface Migration {
@@ -58,7 +59,7 @@ export declare class Migrator {
      * This method goes through all possible migrations provided by the provider and runs the
      * ones whose names come alphabetically after the last migration that has been run. If the
      * list of executed migrations doesn't match the beginning of the list of possible migrations
-     * an error is thrown.
+     * an error is returned.
      *
      * ### Examples
      *
@@ -197,6 +198,20 @@ export interface MigratorProps {
      * This only works on postgres.
      */
     readonly migrationTableSchema?: string;
+    /**
+     * Enforces whether or not migrations must be run in alpha-numeric order.
+     *
+     * When false, migrations must be run in their exact alpha-numeric order.
+     * This is checked against the migrations already run in the database
+     * (`migrationTableName'). This ensures your migrations are always run in
+     * the same order and is the safest option.
+     *
+     * When true, migrations are still run in alpha-numeric order, but
+     * the order is not checked against already-run migrations in the database.
+     * Kysely will simply run all migrations that haven't run yet, in alpha-numeric
+     * order.
+     */
+    readonly allowUnorderedMigrations?: boolean;
 }
 /**
  * All migration methods ({@link Migrator.migrateTo | migrateTo},
@@ -231,12 +246,13 @@ export interface MigrationResultSet {
      */
     readonly results?: MigrationResult[];
 }
+type MigrationDirection = 'Up' | 'Down';
 export interface MigrationResult {
     readonly migrationName: string;
     /**
      * The direction in which this migration was executed.
      */
-    readonly direction: 'Up' | 'Down';
+    readonly direction: MigrationDirection;
     /**
      * The execution status.
      *
@@ -293,3 +309,4 @@ export interface MigrationInfo {
      */
     executedAt?: Date;
 }
+export {};