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

package/MsSqlConnection.d.ts

@@ -2,7 +2,13 @@ import { AbstractSqlConnection, type TransactionEventBroadcaster } from '@mikro-
 import { type ControlledTransaction, MssqlDialect } from 'kysely';
 import { type Routine, type Transaction } from '@mikro-orm/core';
 import type { ConnectionConfiguration } from 'tedious';
-/** Microsoft SQL Server database connection using the `tedious` driver. */
+/**
+ * Microsoft SQL Server database connection using the `tedious` driver.
+ *
+ * There is no `getNativeClient()` here: tedious has no long-lived client object, and the pool
+ * kysely builds holds its own connection wrappers rather than tedious ones. Reach individual
+ * `Tedious.Connection`s through the `onCreateConnection`/`onReserveConnection` hooks instead.
+ */
 export declare class MsSqlConnection extends AbstractSqlConnection {
     createKyselyDialect(overrides: ConnectionConfiguration): MssqlDialect;
     private mapOptions;

package/MsSqlConnection.js

@@ -28,7 +28,13 @@ class MsSqlReserveDialect extends MssqlDialect {
         return driver;
     }
 }
-/** Microsoft SQL Server database connection using the `tedious` driver. */
+/**
+ * Microsoft SQL Server database connection using the `tedious` driver.
+ *
+ * There is no `getNativeClient()` here: tedious has no long-lived client object, and the pool
+ * kysely builds holds its own connection wrappers rather than tedious ones. Reach individual
+ * `Tedious.Connection`s through the `onCreateConnection`/`onReserveConnection` hooks instead.
+ */
 export class MsSqlConnection extends AbstractSqlConnection {
     createKyselyDialect(overrides) {
         const options = this.mapOptions(overrides);

package/MsSqlPlatform.d.ts

@@ -52,6 +52,8 @@ export declare class MsSqlPlatform extends AbstractSqlPlatform {
     }): string;
     getDefaultMappedType(type: string): Type<unknown>;
     getDefaultSchemaName(): string | undefined;
+    getDefaultPrimaryName(tableName: string, columns: string[]): string;
+    supportsCustomPrimaryKeyNames(): boolean;
     getUuidTypeDeclarationSQL(column: {
         length?: number;
     }): string;

package/MsSqlPlatform.js

@@ -139,6 +139,12 @@ export class MsSqlPlatform extends AbstractSqlPlatform {
     getDefaultSchemaName() {
         return 'dbo';
     }
+    getDefaultPrimaryName(tableName, columns) {
+        return this.getIndexName(tableName, columns, 'primary');
+    }
+    supportsCustomPrimaryKeyNames() {
+        return true;
+    }
     getUuidTypeDeclarationSQL(column) {
         return 'uniqueidentifier';
     }
@@ -223,18 +229,19 @@ export class MsSqlPlatform extends AbstractSqlPlatform {
         return collation;
     }
     getOrderByExpression(column, direction, collation) {
+        const dir = this.validateOrderByDirection(direction);
         const col = collation ? `${column} collate ${this.quoteCollation(collation)}` : column;
-        switch (direction.toUpperCase()) {
-            case QueryOrder.ASC_NULLS_FIRST:
+        switch (dir) {
+            case QueryOrder.asc_nulls_first:
                 return [`case when ${column} is null then 0 else 1 end, ${col} asc`];
-            case QueryOrder.ASC_NULLS_LAST:
+            case QueryOrder.asc_nulls_last:
                 return [`case when ${column} is null then 1 else 0 end, ${col} asc`];
-            case QueryOrder.DESC_NULLS_FIRST:
+            case QueryOrder.desc_nulls_first:
                 return [`case when ${column} is null then 0 else 1 end, ${col} desc`];
-            case QueryOrder.DESC_NULLS_LAST:
+            case QueryOrder.desc_nulls_last:
                 return [`case when ${column} is null then 1 else 0 end, ${col} desc`];
             default:
-                return [`${col} ${direction.toLowerCase()}`];
+                return [`${col} ${dir}`];
         }
     }
     getDefaultClientUrl() {

package/MsSqlSchemaGenerator.d.ts

@@ -8,4 +8,5 @@ export declare class MsSqlSchemaGenerator extends SchemaGenerator {
     }): Promise<void>;
     clear(options?: ClearDatabaseOptions): Promise<void>;
     getDropSchemaSQL(options?: Omit<DropSchemaOptions, 'dropDb'>): Promise<string>;
+    protected startsBatch(statement: string): boolean;
 }

package/MsSqlSchemaGenerator.js

@@ -1,4 +1,6 @@
 import { SchemaGenerator } from '@mikro-orm/sql';
+/** MSSQL rejects these unless they are the first statement in a query batch. */
+const BATCH_FIRST_STATEMENT = /^create\s+(or\s+alter\s+)?(trigger|view|proc(edure)?|function|schema)\b/i;
 /** Schema generator with MSSQL-specific behavior for clearing and dropping schemas. */
 export class MsSqlSchemaGenerator extends SchemaGenerator {
     static register(orm) {
@@ -40,4 +42,7 @@ export class MsSqlSchemaGenerator extends SchemaGenerator {
     async getDropSchemaSQL(options = {}) {
         return super.getDropSchemaSQL({ dropForeignKeys: true, ...options });
     }
+    startsBatch(statement) {
+        return BATCH_FIRST_STATEMENT.test(statement);
+    }
 }

package/MsSqlSchemaHelper.d.ts

@@ -51,6 +51,7 @@ export declare class MsSqlSchemaHelper extends SchemaHelper {
     private getDropDefaultsSQL;
     getRenameColumnSQL(tableName: string, oldColumnName: string, to: Column, schemaName?: string): string;
     createTableColumn(column: Column, table: DatabaseTable, changedProperties?: Set<string>): string | undefined;
+    protected getPrimaryKeyConstraintPrefix(table: DatabaseTable, index: IndexDef): string;
     alterTableColumn(column: Column, table: DatabaseTable, changedProperties: Set<string>): string[];
     getCreateIndexSQL(tableName: string, index: IndexDef, partialExpression?: boolean): string;
     /**
@@ -67,6 +68,10 @@ export declare class MsSqlSchemaHelper extends SchemaHelper {
     dropViewIfExists(name: string, schema?: string): string;
     getAddColumnsSQL(table: DatabaseTable, columns: Column[]): string[];
     appendComments(table: DatabaseTable): string[];
+    alterTableComment(table: DatabaseTable, comment?: string): string;
+    getChangeColumnCommentSQL(tableName: string, to: Column, schemaName?: string): string;
+    /** Comments are stored as `MS_Description` extended properties, which have separate add/update/drop procedures. */
+    private getCommentSQL;
     inferLengthFromColumnType(type: string): number | undefined;
     protected wrap(val: string | undefined, type: Type<unknown>): string | undefined;
 }

package/MsSqlSchemaHelper.js

@@ -347,7 +347,7 @@ export class MsSqlSchemaHelper extends SchemaHelper {
         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`;
+        return `create trigger ${qualifiedName} on ${table.getQuotedName()} ${timing} ${events} as begin ${this.normalizeTriggerBody(trigger.body)} end`;
     }
     /** Generates SQL to drop an MSSQL trigger. */
     dropTrigger(table, trigger) {
@@ -400,6 +400,7 @@ export class MsSqlSchemaHelper extends SchemaHelper {
         on ep.major_id = o.object_id and ep.minor_id = 0 and ep.name = 'MS_Description'
       where o.type in ('P', 'FN', 'IF', 'TF')
         and o.is_ms_shipped = 0
+      order by s.name, o.name
     `;
         const [rows, paramsAndReturns] = await Promise.all([
             connection.execute(sql),
@@ -669,7 +670,8 @@ export class MsSqlSchemaHelper extends SchemaHelper {
             !column.generated &&
             !compositePK &&
             (!changedProperties || changedProperties.has('autoincrement') || changedProperties.has('type'))) {
-            Utils.runIfNotEmpty(() => col.push('primary key'), primaryKey && column.primary);
+            const primaryKeyName = this.platform.getDefaultPrimaryName(table.name, [column.name]);
+            Utils.runIfNotEmpty(() => col.push(`constraint ${this.quote(primaryKeyName)} primary key`), primaryKey && column.primary);
         }
         const useDefault = changedProperties
             ? false
@@ -678,6 +680,10 @@ export class MsSqlSchemaHelper extends SchemaHelper {
         Utils.runIfNotEmpty(() => col.push(`constraint ${this.quote(defaultName)} default ${column.default}`), useDefault);
         return col.join(' ');
     }
+    // SQL Server generates a random `PK__…` name when the constraint is unnamed, so always name it
+    getPrimaryKeyConstraintPrefix(table, index) {
+        return `constraint ${this.quote(index.keyName)} `;
+    }
     alterTableColumn(column, table, changedProperties) {
         const parts = [];
         if (changedProperties.has('default')) {
@@ -793,31 +799,49 @@ export class MsSqlSchemaHelper extends SchemaHelper {
             return this.createTableColumn(column, table);
         })
             .join(', ');
-        return [`alter table ${table.getQuotedName()} add ${adds}`];
+        const sql = [`alter table ${table.getQuotedName()} add ${adds}`];
+        for (const column of columns) {
+            if (column.comment) {
+                sql.push(this.getCommentSQL(table.schema, table.name, column.comment, column.name));
+            }
+        }
+        return sql;
     }
     appendComments(table) {
         const sql = [];
-        const schema = this.platform.quoteValue(table.schema);
-        const tableName = this.platform.quoteValue(table.name);
         if (table.comment) {
-            const comment = this.platform.quoteValue(table.comment);
-            sql.push(`if exists(select * from sys.fn_listextendedproperty(N'MS_Description', N'Schema', N${schema}, N'Table', N${tableName}, null, null))
-  exec sys.sp_updateextendedproperty N'MS_Description', N${comment}, N'Schema', N${schema}, N'Table', N${tableName}
-else
-  exec sys.sp_addextendedproperty N'MS_Description', N${comment}, N'Schema', N${schema}, N'Table', N${tableName}`);
+            sql.push(this.getCommentSQL(table.schema, table.name, table.comment));
         }
         for (const column of table.getColumns()) {
             if (column.comment) {
-                const comment = this.platform.quoteValue(column.comment);
-                const columnName = this.platform.quoteValue(column.name);
-                sql.push(`if exists(select * from sys.fn_listextendedproperty(N'MS_Description', N'Schema', N${schema}, N'Table', N${tableName}, N'Column', N${columnName}))
-  exec sys.sp_updateextendedproperty N'MS_Description', N${comment}, N'Schema', N${schema}, N'Table', N${tableName}, N'Column', N${columnName}
-else
-  exec sys.sp_addextendedproperty N'MS_Description', N${comment}, N'Schema', N${schema}, N'Table', N${tableName}, N'Column', N${columnName}`);
+                sql.push(this.getCommentSQL(table.schema, table.name, column.comment, column.name));
             }
         }
         return sql;
     }
+    alterTableComment(table, comment) {
+        return this.getCommentSQL(table.schema, table.name, comment);
+    }
+    getChangeColumnCommentSQL(tableName, to, schemaName) {
+        return this.getCommentSQL(schemaName, tableName, to.comment, to.name);
+    }
+    /** Comments are stored as `MS_Description` extended properties, which have separate add/update/drop procedures. */
+    getCommentSQL(schemaName, tableName, comment, columnName) {
+        const schema = this.platform.quoteValue(schemaName ?? this.platform.getDefaultSchemaName());
+        const table = this.platform.quoteValue(tableName);
+        const level1 = `N'Schema', N${schema}, N'Table', N${table}`;
+        const level2 = columnName ? `N'Column', N${this.platform.quoteValue(columnName)}` : '';
+        const exists = `if exists(select * from sys.fn_listextendedproperty(N'MS_Description', ${level1}, ${level2 || 'null, null'}))`;
+        const target = level2 ? `${level1}, ${level2}` : level1;
+        if (!comment) {
+            return `${exists}\n  exec sys.sp_dropextendedproperty N'MS_Description', ${target}`;
+        }
+        const value = this.platform.quoteValue(comment);
+        return `${exists}
+  exec sys.sp_updateextendedproperty N'MS_Description', N${value}, ${target}
+else
+  exec sys.sp_addextendedproperty N'MS_Description', N${value}, ${target}`;
+    }
     inferLengthFromColumnType(type) {
         const match = /^(\w+)\s*\(\s*(-?\d+|max)\s*\)/.exec(type);
         if (!match) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/mssql",
-  "version": "7.2.0-dev.0",
+  "version": "7.2.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,17 +47,17 @@
     "copy": "node ../../scripts/copy.mjs"
   },
   "dependencies": {
-    "@mikro-orm/sql": "7.2.0-dev.0",
-    "kysely": "0.29.3",
+    "@mikro-orm/sql": "7.2.0-dev.10",
+    "kysely": "0.29.5",
     "tarn": "3.1.2",
     "tedious": "20.0.0",
     "tsqlstring": "1.0.1"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^7.1.6"
+    "@mikro-orm/core": "^7.1.11"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.2.0-dev.0"
+    "@mikro-orm/core": "7.2.0-dev.10"
   },
   "engines": {
     "node": ">= 22.17.0"