@mikro-orm/mssql 7.1.0-dev.3 → 7.1.0-dev.30

package/MsSqlMikroORM.d.ts

@@ -1,5 +1,5 @@
-import { type AnyEntity, type EntityClass, type EntitySchema, MikroORM, type Options, type IDatabaseDriver, type EntityManager, type EntityManagerType } from '@mikro-orm/core';
-import type { SqlEntityManager } from '@mikro-orm/sql';
+import { type AnyEntity, type EntityClass, type EntitySchema, type MikroORM, type Options, type IDatabaseDriver, type EntityManager, type EntityManagerType } from '@mikro-orm/core';
+import { SqlMikroORM, type SqlEntityManager } from '@mikro-orm/sql';
 import { MsSqlDriver } from './MsSqlDriver.js';
 /** Configuration options for the MSSQL driver. */
 export type MsSqlOptions<EM extends SqlEntityManager<MsSqlDriver> = SqlEntityManager<MsSqlDriver>, Entities extends readonly (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> = Partial<Options<MsSqlDriver, EM, Entities>>;
@@ -8,7 +8,7 @@ export declare function defineMsSqlConfig<EM extends SqlEntityManager<MsSqlDrive
 /**
  * @inheritDoc
  */
-export declare class MsSqlMikroORM<EM extends SqlEntityManager<MsSqlDriver> = SqlEntityManager<MsSqlDriver>, Entities extends readonly (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> extends MikroORM<MsSqlDriver, EM, Entities> {
+export declare class MsSqlMikroORM<EM extends SqlEntityManager<MsSqlDriver> = SqlEntityManager<MsSqlDriver>, Entities extends readonly (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> extends SqlMikroORM<MsSqlDriver, EM, Entities> {
     /**
      * @inheritDoc
      */

package/MsSqlMikroORM.js

@@ -1,4 +1,5 @@
-import { defineConfig, MikroORM, } from '@mikro-orm/core';
+import { defineConfig, } from '@mikro-orm/core';
+import { SqlMikroORM } from '@mikro-orm/sql';
 import { MsSqlDriver } from './MsSqlDriver.js';
 /** Creates a type-safe configuration object for the MSSQL driver. */
 export function defineMsSqlConfig(options) {
@@ -7,7 +8,7 @@ export function defineMsSqlConfig(options) {
 /**
  * @inheritDoc
  */
-export class MsSqlMikroORM extends MikroORM {
+export class MsSqlMikroORM extends SqlMikroORM {
     /**
      * @inheritDoc
      */

package/MsSqlPlatform.d.ts

@@ -8,6 +8,7 @@ export declare class MsSqlPlatform extends AbstractSqlPlatform {
     #private;
     protected readonly schemaHelper: MsSqlSchemaHelper;
     protected readonly exceptionConverter: MsSqlExceptionConverter;
+    formatIndexHint(indexNames: string[]): string;
     /** @inheritDoc */
     lookupExtensions(orm: MikroORM<MsSqlDriver>): void;
     /** @inheritDoc */

package/MsSqlPlatform.js

@@ -16,6 +16,9 @@ export class MsSqlPlatform extends AbstractSqlPlatform {
         bigint: 'bigint',
         boolean: 'bit',
     };
+    formatIndexHint(indexNames) {
+        return `with (index(${indexNames.join(', ')}))`;
+    }
     /** @inheritDoc */
     lookupExtensions(orm) {
         MsSqlSchemaGenerator.register(orm);
@@ -136,6 +139,7 @@ export class MsSqlPlatform extends AbstractSqlPlatform {
         return 'uniqueidentifier';
     }
     validateMetadata(meta) {
+        super.validateMetadata(meta);
         for (const prop of meta.props) {
             if ((prop.runtimeType === 'string' || ['string', 'nvarchar'].includes(prop.type)) &&
                 !['uuid'].includes(prop.type) &&
@@ -150,16 +154,17 @@ export class MsSqlPlatform extends AbstractSqlPlatform {
     getSearchJsonPropertyKey(path, type, aliased, value) {
         const [a, ...b] = path;
         /* v8 ignore next */
-        const root = this.quoteIdentifier(aliased ? `${ALIAS_REPLACEMENT}.${a}` : a);
+        const root = aliased ? `[${ALIAS_REPLACEMENT}].${this.quoteIdentifier(a)}` : this.quoteIdentifier(a);
         const types = {
             boolean: 'bit',
         };
         const cast = (key) => raw(type in types ? `cast(${key} as ${types[type]})` : key);
+        const jsonPath = this.quoteValue(`$.${b.map(this.quoteJsonKey).join('.')}`);
         /* v8 ignore next */
         if (path.length === 0) {
-            return cast(`json_value(${root}, '$.${b.map(this.quoteJsonKey).join('.')}')`);
+            return cast(`json_value(${root}, ${jsonPath})`);
         }
-        return cast(`json_value(${root}, '$.${b.map(this.quoteJsonKey).join('.')}')`);
+        return cast(`json_value(${root}, ${jsonPath})`);
     }
     getJsonArrayFromSQL(column, alias, properties) {
         const columns = properties
@@ -187,7 +192,7 @@ export class MsSqlPlatform extends AbstractSqlPlatform {
         if (RawQueryFragment.isKnownFragment(id)) {
             return super.quoteIdentifier(id);
         }
-        return `[${id.toString().replace('.', `].[`)}]`;
+        return `[${id.toString().replaceAll(']', ']]').replace('.', `].[`)}]`;
     }
     escape(value) {
         if (value instanceof UnicodeString) {

package/MsSqlSchemaHelper.d.ts

@@ -1,4 +1,4 @@
-import { type AbstractSqlConnection, type CheckDef, type Column, type DatabaseSchema, type DatabaseTable, type Dictionary, type ForeignKey, type IndexDef, SchemaHelper, type Table, type TableDifference, type Transaction, type Type } from '@mikro-orm/sql';
+import { type AbstractSqlConnection, type CheckDef, type Column, type DatabaseSchema, type DatabaseTable, type Dictionary, type ForeignKey, type IndexDef, SchemaHelper, type Table, type TableDifference, type SqlTriggerDef, type Transaction, type Type } from '@mikro-orm/sql';
 /** Schema introspection helper for Microsoft SQL Server. */
 export declare class MsSqlSchemaHelper extends SchemaHelper {
     static readonly DEFAULT_VALUES: {
@@ -6,6 +6,8 @@ export declare class MsSqlSchemaHelper extends SchemaHelper {
         false: string[];
         'getdate()': string[];
     };
+    private static readonly AUTO_NOT_NULL_RE;
+    protected get bracketQuotedIdentifiers(): boolean;
     getManagementDbName(): string;
     getDropDatabaseSQL(name: string): string;
     disableForeignKeysSQL(): string;
@@ -23,6 +25,13 @@ export declare class MsSqlSchemaHelper extends SchemaHelper {
     private getEnumDefinitions;
     private getChecksSQL;
     getAllChecks(connection: AbstractSqlConnection, tablesBySchemas: Map<string | undefined, Table[]>, ctx?: Transaction): Promise<Dictionary<CheckDef[]>>;
+    /** Generates SQL to create an MSSQL trigger. MSSQL supports AFTER and INSTEAD OF only. */
+    createTrigger(table: DatabaseTable, trigger: SqlTriggerDef): string;
+    /** Generates SQL to drop an MSSQL trigger. */
+    dropTrigger(table: DatabaseTable, trigger: SqlTriggerDef): string;
+    private getSchemaQualifiedName;
+    getDatabaseCollation(connection: AbstractSqlConnection, ctx?: Transaction): Promise<string | undefined>;
+    getAllTriggers(connection: AbstractSqlConnection, tablesBySchemas: Map<string | undefined, Table[]>): Promise<Dictionary<SqlTriggerDef[]>>;
     loadInformationSchema(schema: DatabaseSchema, connection: AbstractSqlConnection, tables: Table[], schemas?: string[], ctx?: Transaction): Promise<void>;
     getPreAlterTable(tableDiff: TableDifference, safe: boolean): string[];
     getPostAlterTable(tableDiff: TableDifference, safe: boolean): string[];

package/MsSqlSchemaHelper.js

@@ -7,12 +7,43 @@ export class MsSqlSchemaHelper extends SchemaHelper {
         false: ['0'],
         'getdate()': ['current_timestamp'],
     };
+    // `stripAutoNotNullFilter` unwraps balanced per-clause parens before calling `.exec`, so we
+    // only need to match the bare form here — previously the pattern allowed independently
+    // optional leading/trailing parens, which accepted unbalanced strings like `([col] IS NOT NULL`.
+    static AUTO_NOT_NULL_RE = /^\[([^\]]+)\]\s+IS\s+NOT\s+NULL$/i;
+    // MSSQL `filter_definition` and `where` predicates use `[…]` bracket-quoting for identifiers,
+    // so `splitTopLevelAnd` must treat `[` as opening a quoted span (otherwise `[some and col]`
+    // would split mid-identifier).
+    get bracketQuotedIdentifiers() {
+        return true;
+    }
     getManagementDbName() {
         return 'master';
     }
     getDropDatabaseSQL(name) {
+        // `set offline` rejects all connections including the issuing session, so there is no
+        // single-user race window where a torn-down pool connection can reconnect between the
+        // mode switch and the drop (SQL Server error 3702 "currently in use"). Dropping an
+        // offline database leaves the underlying `.mdf`/`.ldf` files behind though, which
+        // makes a subsequent `create database` with the same name fail with error 5170
+        // ("file already exists"). Capture the physical paths up front and call
+        // `master.sys.xp_delete_files` after the drop to clean them up.
         const quoted = this.quote(name);
-        return `if db_id(${this.platform.quoteValue(name)}) is not null begin alter database ${quoted} set single_user with rollback immediate; drop database ${quoted}; end`;
+        const literal = this.platform.quoteValue(name);
+        return (`if db_id(${literal}) is not null begin ` +
+            `declare @drop_files table (path nvarchar(260)); ` +
+            `insert into @drop_files (path) select physical_name from sys.master_files where database_id = db_id(${literal}); ` +
+            `alter database ${quoted} set offline with rollback immediate; ` +
+            `drop database ${quoted}; ` +
+            `declare @drop_path nvarchar(260); ` +
+            `declare drop_files_cursor cursor local fast_forward for select path from @drop_files; ` +
+            `open drop_files_cursor; fetch next from drop_files_cursor into @drop_path; ` +
+            `while @@fetch_status = 0 begin ` +
+            `begin try exec master.sys.xp_delete_files @drop_path; end try begin catch end catch; ` +
+            `fetch next from drop_files_cursor into @drop_path; ` +
+            `end ` +
+            `close drop_files_cursor; deallocate drop_files_cursor; ` +
+            `end`);
     }
     disableForeignKeysSQL() {
         return `exec sp_MSforeachtable 'alter table ? nocheck constraint all';`;
@@ -83,7 +114,8 @@ export class MsSqlSchemaHelper extends SchemaHelper {
       numeric_scale as numeric_scale,
       datetime_precision as datetime_precision,
       character_maximum_length as character_maximum_length,
-      columnproperty(sc.object_id, column_name, 'IsIdentity') is_identity
+      columnproperty(sc.object_id, column_name, 'IsIdentity') is_identity,
+      nullif(ic.collation_name, convert(nvarchar(128), databasepropertyex(db_name(), 'Collation'))) as collation_name
       from information_schema.columns ic
       inner join sys.columns sc on sc.name = ic.column_name and sc.object_id = object_id(ic.table_schema + '.' + ic.table_name)
       left join sys.computed_columns cmp on cmp.name = ic.column_name and cmp.object_id = object_id(ic.table_schema + '.' + ic.table_name)
@@ -135,6 +167,7 @@ export class MsSqlSchemaHelper extends SchemaHelper {
                 precision: col.numeric_precision,
                 scale: col.numeric_scale,
                 comment: col.column_comment,
+                collation: col.collation_name ?? undefined,
                 generated,
             });
         }
@@ -148,6 +181,7 @@ export class MsSqlSchemaHelper extends SchemaHelper {
       col.name as column_name,
       schema_name(t.schema_id) as schema_name,
       (case when filter_definition is not null then concat('where ', filter_definition) else null end) as expression,
+      filter_definition as filter_definition,
       ind.is_disabled as is_disabled,
       ind.type as index_type,
       ind.fill_factor as fill_factor,
@@ -192,15 +226,31 @@ export class MsSqlSchemaHelper extends SchemaHelper {
             if (index.fill_factor > 0) {
                 indexDef.fillFactor = index.fill_factor;
             }
-            if (index.column_name?.match(/[(): ,"'`]/) || index.expression?.match(/where /i)) {
-                indexDef.expression = index.expression; // required for the `getCreateIndexSQL()` call
+            /* v8 ignore next: function-based / computed-column introspection path, same as pre-PR */
+            if (index.column_name?.match(/[(): ,"'`]/)) {
+                indexDef.expression = index.expression;
                 indexDef.expression = this.getCreateIndexSQL(index.table_name, indexDef, !!index.expression);
             }
+            else if (index.filter_definition) {
+                // Auto-NOT-NULL stripping runs post-mapIndexes (needs the consolidated column list).
+                indexDef.where = index.filter_definition;
+            }
             ret[key] ??= [];
             ret[key].push(indexDef);
         }
         for (const key of Object.keys(ret)) {
             ret[key] = await this.mapIndexes(ret[key]);
+            for (const idx of ret[key]) {
+                if (idx.where) {
+                    const stripped = this.stripAutoNotNullFilter(idx.where, idx.columnNames, MsSqlSchemaHelper.AUTO_NOT_NULL_RE);
+                    if (stripped === '') {
+                        delete idx.where;
+                    }
+                    else {
+                        idx.where = stripped;
+                    }
+                }
+            }
         }
         return ret;
     }
@@ -285,6 +335,86 @@ export class MsSqlSchemaHelper extends SchemaHelper {
         }
         return ret;
     }
+    /** Generates SQL to create an MSSQL trigger. MSSQL supports AFTER and INSTEAD OF only. */
+    createTrigger(table, trigger) {
+        if (trigger.expression) {
+            return trigger.expression;
+        }
+        /* v8 ignore next 3 */
+        if (trigger.timing === 'before') {
+            throw new Error(`MSSQL does not support BEFORE triggers. Use AFTER or INSTEAD OF for trigger "${trigger.name}".`);
+        }
+        const timing = trigger.timing.toUpperCase();
+        const events = trigger.events.map(e => e.toUpperCase()).join(', ');
+        const qualifiedName = this.getSchemaQualifiedName(table, trigger.name);
+        return `create trigger ${qualifiedName} on ${table.getQuotedName()} ${timing} ${events} as begin ${trigger.body}; end`;
+    }
+    /** Generates SQL to drop an MSSQL trigger. */
+    dropTrigger(table, trigger) {
+        return `drop trigger if exists ${this.getSchemaQualifiedName(table, trigger.name)}`;
+    }
+    getSchemaQualifiedName(table, name) {
+        const defaultSchema = this.platform.getDefaultSchemaName();
+        if (table.schema && table.schema !== defaultSchema) {
+            return `${this.quote(table.schema)}.${this.quote(name)}`;
+        }
+        return this.quote(name);
+    }
+    async getDatabaseCollation(connection, ctx) {
+        const [row] = await connection.execute(`select convert(nvarchar(128), databasepropertyex(db_name(), 'Collation')) as collation`, [], 'all', ctx);
+        return row?.collation;
+    }
+    async getAllTriggers(connection, tablesBySchemas) {
+        const conditions = [];
+        for (const [schema, tables] of tablesBySchemas) {
+            const names = tables.map(t => this.platform.quoteValue(t.table_name)).join(', ');
+            const schemaName = this.platform.quoteValue(schema ?? this.platform.getDefaultSchemaName());
+            conditions.push(`(schema_name(p.schema_id) = ${schemaName} and p.name in (${names}))`);
+        }
+        const sql = `select t.name as trigger_name, schema_name(p.schema_id) as schema_name,
+      p.name as table_name, te.type_desc as event,
+      case when t.is_instead_of_trigger = 1 then 'INSTEAD OF' else 'AFTER' end as timing,
+      object_definition(t.object_id) as definition
+    from sys.triggers t
+    join sys.trigger_events te on t.object_id = te.object_id
+    join sys.objects p on t.parent_id = p.object_id
+    where (${conditions.join(' or ')})
+    order by t.name, te.type_desc`;
+        const allTriggers = await connection.execute(sql);
+        const ret = {};
+        const triggerMap = new Map();
+        for (const row of allTriggers) {
+            const key = this.getTableKey(row);
+            const dedupeKey = `${key}:${row.trigger_name}`;
+            const event = row.event.toLowerCase();
+            if (triggerMap.has(dedupeKey)) {
+                const existing = triggerMap.get(dedupeKey);
+                if (!existing.events.includes(event)) {
+                    existing.events.push(event);
+                }
+                continue;
+            }
+            // Parse body from full trigger definition
+            let body = '';
+            if (row.definition) {
+                const bodyMatch = /\bas\s+begin\s+([\s\S]*)\s*end\s*;?\s*$/i.exec(row.definition);
+                if (bodyMatch) {
+                    body = bodyMatch[1].trim().replace(/;\s*$/, '');
+                }
+            }
+            ret[key] ??= [];
+            const trigger = {
+                name: row.trigger_name,
+                timing: row.timing.toLowerCase(),
+                events: [event],
+                forEach: 'row', // MSSQL has no FOR EACH ROW/STATEMENT syntax; match the metadata default to avoid false diffs
+                body,
+            };
+            ret[key].push(trigger);
+            triggerMap.set(dedupeKey, trigger);
+        }
+        return ret;
+    }
     async loadInformationSchema(schema, connection, tables, schemas, ctx) {
         if (tables.length === 0) {
             return;
@@ -294,12 +424,18 @@ export class MsSqlSchemaHelper extends SchemaHelper {
         const indexes = await this.getAllIndexes(connection, tablesBySchema, ctx);
         const checks = await this.getAllChecks(connection, tablesBySchema, ctx);
         const fks = await this.getAllForeignKeys(connection, tablesBySchema, ctx);
+        const triggers = await this.getAllTriggers(connection, tablesBySchema);
+        const dbCollation = await this.getDatabaseCollation(connection, ctx);
         for (const t of tables) {
             const key = this.getTableKey(t);
             const table = schema.addTable(t.table_name, t.schema_name, t.table_comment);
+            table.collation = dbCollation;
             const pks = await this.getPrimaryKeys(connection, indexes[key], table.name, table.schema);
             const enums = this.getEnumDefinitions(checks[key] ?? []);
             table.init(columns[key], indexes[key], checks[key], pks, fks[key], enums);
+            if (triggers[key]) {
+                table.setTriggers(triggers[key]);
+            }
         }
     }
     getPreAlterTable(tableDiff, safe) {
@@ -415,7 +551,11 @@ export class MsSqlSchemaHelper extends SchemaHelper {
         else {
             col.push(columnType);
         }
-        Utils.runIfNotEmpty(() => col.push('identity(1,1)'), column.autoincrement);
+        Utils.runIfNotEmpty(() => col.push(this.getCollateSQL(column.collation)), column.collation);
+        // `IDENTITY(1,1)` is rejected inside `ALTER COLUMN`, so it must only be emitted when the
+        // change actually involves the identity attribute or is a fresh column (no `changedProperties`).
+        Utils.runIfNotEmpty(() => col.push('identity(1,1)'), column.autoincrement &&
+            (!changedProperties || changedProperties.has('autoincrement') || changedProperties.has('type')));
         Utils.runIfNotEmpty(() => col.push('null'), column.nullable);
         Utils.runIfNotEmpty(() => col.push('not null'), !column.nullable && !column.generated);
         if (column.autoincrement &&
@@ -437,7 +577,7 @@ export class MsSqlSchemaHelper extends SchemaHelper {
             const [constraint] = this.getDropDefaultsSQL(table.name, [column], table.schema);
             parts.push(constraint);
         }
-        if (changedProperties.has('type') || changedProperties.has('nullable')) {
+        if (changedProperties.has('type') || changedProperties.has('nullable') || changedProperties.has('collation')) {
             const col = this.createTableColumn(column, table, changedProperties);
             parts.push(`alter table ${table.getQuotedName()} alter column ${col}`);
         }
@@ -460,7 +600,7 @@ export class MsSqlSchemaHelper extends SchemaHelper {
         const clustered = index.clustered ? 'clustered ' : '';
         let sql = `create ${index.unique ? 'unique ' : ''}${clustered}index ${keyName} on ${this.quote(tableName)} `;
         if (index.expression && partialExpression) {
-            return sql + `(${index.expression})` + this.getMsSqlIndexSuffix(index);
+            return sql + `(${index.expression})` + this.getMsSqlIndexSuffix(index) + this.getIndexWhereClause(index);
         }
         // Build column list with advanced options
         const columns = this.getIndexColumns(index);
@@ -469,7 +609,7 @@ export class MsSqlSchemaHelper extends SchemaHelper {
         if (index.include?.length) {
             sql += ` include (${index.include.map(c => this.quote(c)).join(', ')})`;
         }
-        sql += this.getMsSqlIndexSuffix(index);
+        sql += this.getMsSqlIndexSuffix(index) + this.getIndexWhereClause(index);
         // Disabled indexes need to be created first, then disabled
         if (index.disabled) {
             sql += `;\nalter index ${keyName} on ${this.quote(tableName)} disable`;
@@ -514,13 +654,16 @@ export class MsSqlSchemaHelper extends SchemaHelper {
         if (index.expression) {
             return index.expression;
         }
-        const needsWhereClause = index.unique && index.columnNames.some(column => table.getColumn(column)?.nullable);
-        if (!needsWhereClause) {
+        const needsAutoNotNull = index.unique && index.columnNames.some(column => table.getColumn(column)?.nullable);
+        if (!needsAutoNotNull) {
             return this.getCreateIndexSQL(table.getShortestName(), index);
         }
-        // Generate without disabled suffix, insert WHERE clause, then re-add disabled
-        let sql = this.getCreateIndexSQL(table.getShortestName(), { ...index, disabled: false });
-        sql += ' where ' + index.columnNames.map(c => `${this.quote(c)} is not null`).join(' and ');
+        // Strip `index.where` from the base SQL so we can combine it with the auto NOT-NULL guard
+        // ourselves, wrapping the user predicate in parens to defuse operator precedence
+        // (a bare `a = 1 or b = 2 and [col] is not null` would bind as `a = 1 or (b = 2 and …)`).
+        let sql = this.getCreateIndexSQL(table.getShortestName(), { ...index, where: undefined, disabled: false });
+        const autoNotNull = index.columnNames.map(c => `${this.quote(c)} is not null`).join(' and ');
+        sql += index.where ? ` where (${index.where}) and ${autoNotNull}` : ` where ${autoNotNull}`;
         if (index.disabled) {
             sql += `;\nalter index ${this.quote(index.keyName)} on ${table.getQuotedName()} disable`;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/mssql",
-  "version": "7.1.0-dev.3",
+  "version": "7.1.0-dev.30",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "keywords": [
     "data-mapper",
@@ -47,17 +47,17 @@
     "copy": "node ../../scripts/copy.mjs"
   },
   "dependencies": {
-    "@mikro-orm/sql": "7.1.0-dev.3",
-    "kysely": "0.28.16",
+    "@mikro-orm/sql": "7.1.0-dev.30",
+    "kysely": "0.28.17",
     "tarn": "3.0.2",
     "tedious": "19.2.1",
     "tsqlstring": "1.0.1"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^7.0.11"
+    "@mikro-orm/core": "^7.0.15"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.1.0-dev.3"
+    "@mikro-orm/core": "7.1.0-dev.30"
   },
   "engines": {
     "node": ">= 22.17.0"