@mikro-orm/mssql 7.1.0-dev.0 → 7.1.0-dev.10

package/MsSqlMikroORM.d.ts

@@ -2,17 +2,17 @@ import { type AnyEntity, type EntityClass, type EntitySchema, MikroORM, type Opt
 import 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 (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> = Partial<Options<MsSqlDriver, EM, Entities>>;
+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>>;
 /** Creates a type-safe configuration object for the MSSQL driver. */
-export declare function defineMsSqlConfig<EM extends SqlEntityManager<MsSqlDriver> = SqlEntityManager<MsSqlDriver>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: Partial<Options<MsSqlDriver, EM, Entities>>): Partial<Options<MsSqlDriver, EM, Entities>>;
+export declare function defineMsSqlConfig<EM extends SqlEntityManager<MsSqlDriver> = SqlEntityManager<MsSqlDriver>, Entities extends readonly (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: Partial<Options<MsSqlDriver, EM, Entities>>): Partial<Options<MsSqlDriver, EM, Entities>>;
 /**
  * @inheritDoc
  */
-export declare class MsSqlMikroORM<EM extends SqlEntityManager<MsSqlDriver> = SqlEntityManager<MsSqlDriver>, Entities extends (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 MikroORM<MsSqlDriver, EM, Entities> {
     /**
      * @inheritDoc
      */
-    static init<D extends IDatabaseDriver = MsSqlDriver, EM extends EntityManager<D> = D[typeof EntityManagerType] & EntityManager<D>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: Partial<Options<D, EM, Entities>>): Promise<MikroORM<D, EM, Entities>>;
+    static init<D extends IDatabaseDriver = MsSqlDriver, EM extends EntityManager<D> = D[typeof EntityManagerType] & EntityManager<D>, Entities extends readonly (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: Partial<Options<D, EM, Entities>>): Promise<MikroORM<D, EM, Entities>>;
     /**
      * @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);

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: {
@@ -23,6 +23,12 @@ 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;
+    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

@@ -285,6 +285,82 @@ 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 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 +370,16 @@ 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);
         for (const t of tables) {
             const key = this.getTableKey(t);
             const table = schema.addTable(t.table_name, t.schema_name, t.table_comment);
             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) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/mssql",
-  "version": "7.1.0-dev.0",
+  "version": "7.1.0-dev.10",
   "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,7 +47,7 @@
     "copy": "node ../../scripts/copy.mjs"
   },
   "dependencies": {
-    "@mikro-orm/sql": "7.1.0-dev.0",
+    "@mikro-orm/sql": "7.1.0-dev.10",
     "kysely": "0.28.16",
     "tarn": "3.0.2",
     "tedious": "19.2.1",
@@ -57,7 +57,7 @@
     "@mikro-orm/core": "^7.0.11"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.1.0-dev.0"
+    "@mikro-orm/core": "7.1.0-dev.10"
   },
   "engines": {
     "node": ">= 22.17.0"