@mikro-orm/mssql 7.0.0-dev.30 → 7.0.0-dev.301

package/MsSqlSchemaHelper.js

@@ -1,9 +1,9 @@
-import { EnumType, SchemaHelper, StringType, TextType, Utils, } from '@mikro-orm/knex';
+import { EnumType, SchemaHelper, StringType, TextType, Utils, } from '@mikro-orm/sql';
 import { UnicodeStringType } from './UnicodeStringType.js';
 export class MsSqlSchemaHelper extends SchemaHelper {
     static DEFAULT_VALUES = {
-        'true': ['1'],
-        'false': ['0'],
+        true: ['1'],
+        false: ['0'],
         'getdate()': ['current_timestamp'],
     };
     getManagementDbName() {
@@ -25,6 +25,24 @@ export class MsSqlSchemaHelper extends SchemaHelper {
       left join sys.extended_properties ep on ep.major_id = t.id and ep.name = 'MS_Description' and ep.minor_id = 0
       order by schema_name(t2.schema_id), t.name`;
     }
+    getListViewsSQL() {
+        return `select v.name as view_name, schema_name(v.schema_id) as schema_name, m.definition as view_definition
+      from sys.views v
+      inner join sys.sql_modules m on v.object_id = m.object_id
+      order by schema_name(v.schema_id), v.name`;
+    }
+    async loadViews(schema, connection) {
+        const views = await connection.execute(this.getListViewsSQL());
+        for (const view of views) {
+            // Extract SELECT statement from CREATE VIEW ... AS SELECT ...
+            const match = view.view_definition?.match(/\bAS\s+(.+)$/is);
+            const definition = match?.[1]?.trim();
+            if (definition) {
+                const schemaName = view.schema_name === this.platform.getDefaultSchemaName() ? undefined : view.schema_name;
+                schema.addView(view.view_name, schemaName, definition);
+            }
+        }
+    }
     async getNamespaces(connection) {
         const sql = `select name as schema_name from sys.schemas order by name`;
         const res = await connection.execute(sql);
@@ -69,7 +87,7 @@ export class MsSqlSchemaHelper extends SchemaHelper {
       where (${[...tablesBySchemas.entries()].map(([schema, tables]) => `(ic.table_name in (${tables.map(t => this.platform.quoteValue(t.table_name)).join(',')}) and ic.table_schema = '${schema}')`).join(' OR ')})
       order by ordinal_position`;
         const allColumns = await connection.execute(sql);
-        const str = (val) => val != null ? '' + val : val;
+        const str = (val) => (val != null ? '' + val : val);
         const ret = {};
         for (const col of allColumns) {
             const mappedType = this.platform.getMappedType(col.data_type);
@@ -77,7 +95,9 @@ export class MsSqlSchemaHelper extends SchemaHelper {
             const increments = col.is_identity === 1 && connection.getPlatform().isNumericColumn(mappedType);
             const key = this.getTableKey(col);
             /* v8 ignore next */
-            const generated = col.generation_expression ? `${col.generation_expression}${col.is_persisted ? ' persisted' : ''}` : undefined;
+            const generated = col.generation_expression
+                ? `${col.generation_expression}${col.is_persisted ? ' persisted' : ''}`
+                : undefined;
             let type = col.data_type;
             if (['varchar', 'nvarchar', 'char', 'nchar', 'varbinary'].includes(col.data_type)) {
                 col.length = col.character_maximum_length;
@@ -97,7 +117,9 @@ export class MsSqlSchemaHelper extends SchemaHelper {
             ret[key] ??= [];
             ret[key].push({
                 name: col.column_name,
-                type: this.platform.isNumericColumn(mappedType) ? col.data_type.replace(/ unsigned$/, '').replace(/\(\d+\)$/, '') : type,
+                type: this.platform.isNumericColumn(mappedType)
+                    ? col.data_type.replace(/ unsigned$/, '').replace(/\(\d+\)$/, '')
+                    : type,
                 mappedType,
                 unsigned: col.data_type.endsWith(' unsigned'),
                 length: col.length,
@@ -120,25 +142,51 @@ export class MsSqlSchemaHelper extends SchemaHelper {
       ind.is_primary_key as is_primary_key,
       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
+      (case when filter_definition is not null then concat('where ', filter_definition) else null end) as expression,
+      ind.is_disabled as is_disabled,
+      ind.type as index_type,
+      ind.fill_factor as fill_factor,
+      ic.is_included_column as is_included_column,
+      ic.is_descending_key as is_descending_key
       from sys.indexes ind
       inner join sys.index_columns ic on ind.object_id = ic.object_id and ind.index_id = ic.index_id
       inner join sys.columns col on ic.object_id = col.object_id and ic.column_id = col.column_id
       inner join sys.tables t on ind.object_id = t.object_id
       where
       (${[...tablesBySchemas.entries()].map(([schema, tables]) => `(t.name in (${tables.map(t => this.platform.quoteValue(t.table_name)).join(',')}) and schema_name(t.schema_id) = '${schema}')`).join(' OR ')})
-      order by t.name, ind.name, ind.index_id`;
+      order by t.name, ind.name, ic.is_included_column, ic.key_ordinal`;
         const allIndexes = await connection.execute(sql);
         const ret = {};
         for (const index of allIndexes) {
             const key = this.getTableKey(index);
+            const isIncluded = index.is_included_column;
             const indexDef = {
-                columnNames: [index.column_name],
+                columnNames: isIncluded ? [] : [index.column_name],
                 keyName: index.index_name,
                 unique: index.is_unique,
                 primary: index.is_primary_key,
                 constraint: index.is_unique,
             };
+            // Capture INCLUDE columns
+            if (isIncluded) {
+                indexDef.include = [index.column_name];
+            }
+            // Capture sort order for key columns
+            if (!isIncluded && index.is_descending_key) {
+                indexDef.columns = [{ name: index.column_name, sort: 'DESC' }];
+            }
+            // Capture disabled flag
+            if (index.is_disabled) {
+                indexDef.disabled = true;
+            }
+            // Capture clustered flag (type 1 = clustered)
+            if (index.index_type === 1 && !index.is_primary_key) {
+                indexDef.clustered = true;
+            }
+            // Capture fill factor (0 means default, so only set if non-zero)
+            if (index.fill_factor > 0) {
+                indexDef.fillFactor = index.fill_factor;
+            }
             if (!index.column_name || index.column_name.match(/[(): ,"'`]/) || index.expression?.match(/where /i)) {
                 indexDef.expression = index.expression; // required for the `getCreateIndexSQL()` call
                 indexDef.expression = this.getCreateIndexSQL(index.table_name, indexDef, !!index.expression);
@@ -193,7 +241,12 @@ export class MsSqlSchemaHelper extends SchemaHelper {
             /* v8 ignore next */
             const hasItems = (items?.length ?? 0) > 0;
             if (item.columnName && hasItems) {
-                items = items.map(val => val.trim().replace(`[${item.columnName}]=`, '').match(/^\(?'(.*)'/)?.[1]).filter(Boolean);
+                items = items
+                    .map(val => val
+                    .trim()
+                    .replace(`[${item.columnName}]=`, '')
+                    .match(/^\(?'(.*)'/)?.[1])
+                    .filter(Boolean);
                 if (items.length > 0) {
                     o[item.columnName] = items.reverse();
                 }
@@ -266,7 +319,7 @@ export class MsSqlSchemaHelper extends SchemaHelper {
             }
             // convert to string first if it's not already a string or has a smaller length
             const type = this.platform.extractSimpleType(col.fromColumn.type);
-            if (!['varchar', 'nvarchar', 'varbinary'].includes(type) || (col.fromColumn.length < col.column.length)) {
+            if (!['varchar', 'nvarchar', 'varbinary'].includes(type) || col.fromColumn.length < col.column.length) {
                 ret.push(`alter table ${quotedName} alter column [${col.oldColumnName}] nvarchar(max)`);
             }
         }
@@ -328,18 +381,21 @@ export class MsSqlSchemaHelper extends SchemaHelper {
             }
             const i = globalThis.idx;
             globalThis.idx++;
-            constraints.push(`declare @constraint${i} varchar(100) = (select default_constraints.name from sys.all_columns`
-                + ' join sys.tables on all_columns.object_id = tables.object_id'
-                + ' join sys.schemas on tables.schema_id = schemas.schema_id'
-                + ' join sys.default_constraints on all_columns.default_object_id = default_constraints.object_id'
-                + ` where schemas.name = '${schemaName}' and tables.name = '${tableName}' and all_columns.name = '${column.name}')`
-                + ` if @constraint${i} is not null exec('alter table ${tableNameRaw} drop constraint ' + @constraint${i})`);
+            constraints.push(`declare @constraint${i} varchar(100) = (select default_constraints.name from sys.all_columns` +
+                ' join sys.tables on all_columns.object_id = tables.object_id' +
+                ' join sys.schemas on tables.schema_id = schemas.schema_id' +
+                ' join sys.default_constraints on all_columns.default_object_id = default_constraints.object_id' +
+                ` where schemas.name = '${schemaName}' and tables.name = '${tableName}' and all_columns.name = '${column.name}')` +
+                ` if @constraint${i} is not null exec('alter table ${tableNameRaw} drop constraint ' + @constraint${i})`);
         }
         return constraints;
     }
     getRenameColumnSQL(tableName, oldColumnName, to, schemaName) {
         /* v8 ignore next */
-        const oldName = (schemaName && schemaName !== this.platform.getDefaultSchemaName() ? schemaName + '.' : '') + tableName + '.' + oldColumnName;
+        const oldName = (schemaName && schemaName !== this.platform.getDefaultSchemaName() ? schemaName + '.' : '') +
+            tableName +
+            '.' +
+            oldColumnName;
         const columnName = this.platform.quoteValue(to.name);
         return `exec sp_rename ${this.platform.quoteValue(oldName)}, ${columnName}, 'COLUMN'`;
     }
@@ -348,7 +404,10 @@ export class MsSqlSchemaHelper extends SchemaHelper {
         const primaryKey = !changedProperties && !this.hasNonDefaultPrimaryKeyName(table);
         const columnType = column.generated ? `as ${column.generated}` : column.type;
         const col = [this.quote(column.name)];
-        if (column.autoincrement && !column.generated && !compositePK && (!changedProperties || changedProperties.has('autoincrement') || changedProperties.has('type'))) {
+        if (column.autoincrement &&
+            !column.generated &&
+            !compositePK &&
+            (!changedProperties || changedProperties.has('autoincrement') || changedProperties.has('type'))) {
             col.push(column.mappedType.getColumnType({ autoincrement: true }, this.platform));
         }
         else {
@@ -357,10 +416,15 @@ export class MsSqlSchemaHelper extends SchemaHelper {
         Utils.runIfNotEmpty(() => col.push('identity(1,1)'), column.autoincrement);
         Utils.runIfNotEmpty(() => col.push('null'), column.nullable);
         Utils.runIfNotEmpty(() => col.push('not null'), !column.nullable && !column.generated);
-        if (column.autoincrement && !column.generated && !compositePK && (!changedProperties || changedProperties.has('autoincrement') || changedProperties.has('type'))) {
+        if (column.autoincrement &&
+            !column.generated &&
+            !compositePK &&
+            (!changedProperties || changedProperties.has('autoincrement') || changedProperties.has('type'))) {
             Utils.runIfNotEmpty(() => col.push('primary key'), primaryKey && column.primary);
         }
-        const useDefault = changedProperties ? false : column.default != null && column.default !== 'null' && !column.autoincrement;
+        const useDefault = changedProperties
+            ? false
+            : column.default != null && column.default !== 'null' && !column.autoincrement;
         const defaultName = this.platform.getConfig().getNamingStrategy().indexName(table.name, [column.name], 'default');
         Utils.runIfNotEmpty(() => col.push(`constraint ${this.quote(defaultName)} default ${column.default}`), useDefault);
         return col.join(' ');
@@ -382,17 +446,64 @@ export class MsSqlSchemaHelper extends SchemaHelper {
         return parts;
     }
     getCreateIndexSQL(tableName, index, partialExpression = false) {
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (index.expression && !partialExpression) {
             return index.expression;
         }
+        if (index.fillFactor != null && (index.fillFactor < 0 || index.fillFactor > 100)) {
+            throw new Error(`fillFactor must be between 0 and 100, got ${index.fillFactor} for index '${index.keyName}'`);
+        }
         const keyName = this.quote(index.keyName);
-        const defer = index.deferMode ? ` deferrable initially ${index.deferMode}` : '';
-        const sql = `create ${index.unique ? 'unique ' : ''}index ${keyName} on ${this.quote(tableName)} `;
+        // Only add clustered keyword when explicitly requested, otherwise omit (defaults to nonclustered)
+        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})${defer}`;
+            return sql + `(${index.expression})` + this.getMsSqlIndexSuffix(index);
+        }
+        // Build column list with advanced options
+        const columns = this.getIndexColumns(index);
+        sql += `(${columns})`;
+        // Add INCLUDE clause for covering indexes
+        if (index.include?.length) {
+            sql += ` include (${index.include.map(c => this.quote(c)).join(', ')})`;
         }
-        return super.getCreateIndexSQL(tableName, index);
+        sql += this.getMsSqlIndexSuffix(index);
+        // Disabled indexes need to be created first, then disabled
+        if (index.disabled) {
+            sql += `;\nalter index ${keyName} on ${this.quote(tableName)} disable`;
+        }
+        return sql;
+    }
+    /**
+     * Build the column list for a MSSQL index.
+     */
+    getIndexColumns(index) {
+        if (index.columns?.length) {
+            return index.columns
+                .map(col => {
+                let colDef = this.quote(col.name);
+                // MSSQL supports sort order
+                if (col.sort) {
+                    colDef += ` ${col.sort}`;
+                }
+                return colDef;
+            })
+                .join(', ');
+        }
+        return index.columnNames.map(c => this.quote(c)).join(', ');
+    }
+    /**
+     * Get MSSQL-specific index WITH options like fill factor.
+     */
+    getMsSqlIndexSuffix(index) {
+        const withOptions = [];
+        if (index.fillFactor != null) {
+            withOptions.push(`fillfactor = ${index.fillFactor}`);
+        }
+        if (withOptions.length > 0) {
+            return ` with (${withOptions.join(', ')})`;
+        }
+        return '';
     }
     createIndex(index, table, createPrimary = false) {
         if (index.primary) {
@@ -401,13 +512,17 @@ export class MsSqlSchemaHelper extends SchemaHelper {
         if (index.expression) {
             return index.expression;
         }
-        const quotedTableName = table.getQuotedName();
-        if (index.unique) {
-            const nullable = index.columnNames.some(column => table.getColumn(column)?.nullable);
-            const where = nullable ? ' where ' + index.columnNames.map(c => `${this.quote(c)} is not null`).join(' and ') : '';
-            return `create unique index ${this.quote(index.keyName)} on ${quotedTableName} (${index.columnNames.map(c => this.quote(c)).join(', ')})${where}`;
+        const needsWhereClause = index.unique && index.columnNames.some(column => table.getColumn(column)?.nullable);
+        if (!needsWhereClause) {
+            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 ');
+        if (index.disabled) {
+            sql += `;\nalter index ${this.quote(index.keyName)} on ${table.getQuotedName()} disable`;
         }
-        return super.createIndex(index, table);
+        return sql;
     }
     dropForeignKey(tableName, constraintName) {
         return `alter table ${this.quote(tableName)} drop constraint ${this.quote(constraintName)}`;
@@ -418,10 +533,16 @@ export class MsSqlSchemaHelper extends SchemaHelper {
         }
         return `if object_id('${this.quote(schema, name)}', 'U') is not null drop table ${this.quote(schema, name)}`;
     }
+    dropViewIfExists(name, schema) {
+        const viewName = this.quote(this.getTableName(name, schema));
+        return `if object_id('${viewName}', 'V') is not null drop view ${viewName}`;
+    }
     getAddColumnsSQL(table, columns) {
-        const adds = columns.map(column => {
+        const adds = columns
+            .map(column => {
             return `${this.createTableColumn(column, table)}`;
-        }).join(', ');
+        })
+            .join(', ');
         return [`alter table ${table.getQuotedName()} add ${adds}`];
     }
     appendComments(table) {
@@ -458,7 +579,10 @@ else
         return +match[2];
     }
     wrap(val, type) {
-        const stringType = type instanceof StringType || type instanceof TextType || type instanceof EnumType || type instanceof UnicodeStringType;
+        const stringType = type instanceof StringType ||
+            type instanceof TextType ||
+            type instanceof EnumType ||
+            type instanceof UnicodeStringType;
         return typeof val === 'string' && val.length > 0 && stringType ? this.platform.quoteValue(val) : val;
     }
 }

package/README.md

@@ -381,6 +381,8 @@ See also the list of contributors who [participated](https://github.com/mikro-or
 
 Please ⭐️ this repository if this project helped you!
 
+> If you'd like to support my open-source work, consider sponsoring me directly at [github.com/sponsors/b4nan](https://github.com/sponsors/b4nan).
+
 ## 📝 License
 
 Copyright © 2018 [Martin Adámek](https://github.com/b4nan).

package/UnicodeStringType.js

@@ -23,7 +23,7 @@ export class UnicodeStringType extends Type {
         return `nvarchar(${length})`;
     }
     convertToJSValue(value) {
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (value instanceof UnicodeString) {
             return value.value;
         }

package/index.d.ts

@@ -1,8 +1,7 @@
-export * from '@mikro-orm/knex';
+export * from '@mikro-orm/sql';
 export * from './MsSqlConnection.js';
 export * from './MsSqlDriver.js';
 export * from './MsSqlPlatform.js';
 export * from './MsSqlSchemaHelper.js';
-export * from './MsSqlExceptionConverter.js';
 export * from './UnicodeStringType.js';
-export { MsSqlMikroORM as MikroORM, MsSqlOptions as Options, defineMsSqlConfig as defineConfig, } from './MsSqlMikroORM.js';
+export { MsSqlMikroORM as MikroORM, type MsSqlOptions as Options, defineMsSqlConfig as defineConfig, } from './MsSqlMikroORM.js';

package/index.js

@@ -1,8 +1,7 @@
-export * from '@mikro-orm/knex';
+export * from '@mikro-orm/sql';
 export * from './MsSqlConnection.js';
 export * from './MsSqlDriver.js';
 export * from './MsSqlPlatform.js';
 export * from './MsSqlSchemaHelper.js';
-export * from './MsSqlExceptionConverter.js';
 export * from './UnicodeStringType.js';
 export { MsSqlMikroORM as MikroORM, defineMsSqlConfig as defineConfig, } from './MsSqlMikroORM.js';

package/package.json

@@ -1,66 +1,65 @@
 {
   "name": "@mikro-orm/mssql",
-  "type": "module",
-  "version": "7.0.0-dev.30",
+  "version": "7.0.0-dev.301",
   "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.",
-  "exports": {
-    "./package.json": "./package.json",
-    ".": "./index.js"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
-  },
   "keywords": [
-    "orm",
+    "data-mapper",
+    "ddd",
+    "entity",
+    "identity-map",
+    "javascript",
+    "js",
+    "mariadb",
+    "mikro-orm",
     "mongo",
     "mongodb",
     "mysql",
-    "mariadb",
+    "orm",
     "postgresql",
     "sqlite",
     "sqlite3",
     "ts",
     "typescript",
-    "js",
-    "javascript",
-    "entity",
-    "ddd",
-    "mikro-orm",
-    "unit-of-work",
-    "data-mapper",
-    "identity-map"
+    "unit-of-work"
   ],
-  "author": "Martin Adámek",
-  "license": "MIT",
+  "homepage": "https://mikro-orm.io",
   "bugs": {
     "url": "https://github.com/mikro-orm/mikro-orm/issues"
   },
-  "homepage": "https://mikro-orm.io",
-  "engines": {
-    "node": ">= 22.11.0"
+  "license": "MIT",
+  "author": "Martin Adámek",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
+  },
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": "./index.js"
+  },
+  "publishConfig": {
+    "access": "public"
   },
   "scripts": {
-    "build": "yarn clean && yarn compile && yarn copy",
+    "build": "yarn compile && yarn copy",
     "clean": "yarn run -T rimraf ./dist",
     "compile": "yarn run -T tsc -p tsconfig.build.json",
     "copy": "node ../../scripts/copy.mjs"
   },
-  "publishConfig": {
-    "access": "public"
-  },
   "dependencies": {
-    "@mikro-orm/knex": "7.0.0-dev.30",
+    "@mikro-orm/sql": "7.0.0-dev.301",
+    "kysely": "0.28.11",
     "tarn": "3.0.2",
-    "tedious": "19.0.0",
+    "tedious": "19.2.1",
     "tsqlstring": "1.0.1"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^6.5.7",
-    "kysely": "0.28.7"
+    "@mikro-orm/core": "^6.6.8"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.0-dev.30",
-    "kysely": "*"
+    "@mikro-orm/core": "7.0.0-dev.301"
+  },
+  "engines": {
+    "node": ">= 22.17.0"
   }
 }