@mikro-orm/mongodb 7.1.0-dev.13 → 7.1.0-dev.15

package/MongoSchemaGenerator.d.ts

@@ -21,6 +21,11 @@ export declare class MongoSchemaGenerator extends AbstractSchemaGenerator<MongoD
     ensureIndexes(options?: EnsureIndexesOptions): Promise<void>;
     private mapIndexProperties;
     private createIndexes;
+    /**
+     * An explicit `options.partialFilterExpression` wins over `where` — this preserves the
+     * long-standing `options: { partialFilterExpression }` escape hatch.
+     */
+    private applyPartialFilter;
     private executeQuery;
     private createUniqueIndexes;
     private createPropertyIndexes;

package/MongoSchemaGenerator.js

@@ -132,10 +132,21 @@ export class MongoSchemaGenerator extends AbstractSchemaGenerator {
             const properties = this.mapIndexProperties(index, meta);
             const collection = this.connection.getCollection(meta.class);
             if (Array.isArray(index.options) && index.options.length === 2 && properties.length === 0) {
-                res.push([collection.collectionName, collection.createIndex(index.options[0], index.options[1])]);
+                // The array-form escape hatch passes raw [spec, options] to the driver; fold `where`
+                // into the options dict (on a clone, to avoid mutating the user's metadata).
+                const opts = { ...index.options[1] };
+                this.applyPartialFilter(opts, index.where, index.name, meta.className);
+                res.push([collection.collectionName, collection.createIndex(index.options[0], opts)]);
                 return;
             }
             if (index.options && properties.length === 0) {
+                // The plain escape hatch forwards `index.options` as the sole argument; there is
+                // no options slot for `partialFilterExpression`, so warn instead of silently dropping.
+                if (index.where != null) {
+                    this.config
+                        .getLogger()
+                        .warn('schema', `Index '${index.name ?? '(unnamed)'}' on entity '${meta.className}': \`where\` was ignored because \`options\` is used as the raw index spec and leaves no slot for \`partialFilterExpression\` — pass \`options: [spec, { partialFilterExpression }]\` (array form) to combine both.`);
+                }
                 res.push([collection.collectionName, collection.createIndex(index.options)]);
                 return;
             }
@@ -162,10 +173,30 @@ export class MongoSchemaGenerator extends AbstractSchemaGenerator {
             if (index.invisible) {
                 indexOptions.hidden = true;
             }
+            this.applyPartialFilter(indexOptions, index.where, index.name, meta.className);
             res.push([collection.collectionName, this.executeQuery(collection, 'createIndex', fieldOrSpec, indexOptions)]);
         });
         return res;
     }
+    /**
+     * An explicit `options.partialFilterExpression` wins over `where` — this preserves the
+     * long-standing `options: { partialFilterExpression }` escape hatch.
+     */
+    applyPartialFilter(options, where, indexName, entityName) {
+        if (where == null) {
+            return;
+        }
+        if (options.partialFilterExpression != null) {
+            this.config
+                .getLogger()
+                .warn('schema', `Index '${indexName ?? '(unnamed)'}' on entity '${entityName}': both \`where\` and \`options.partialFilterExpression\` are set; \`options.partialFilterExpression\` wins.`);
+            return;
+        }
+        if (typeof where === 'string') {
+            throw new Error(`Index '${indexName ?? '(unnamed)'}' on entity '${entityName}': string \`where\` is not supported on MongoDB; pass an object/FilterQuery (it maps to MongoDB's \`partialFilterExpression\`).`);
+        }
+        options.partialFilterExpression = where;
+    }
     async executeQuery(collection, method, ...args) {
         const now = Date.now();
         return collection[method](...args).then((res) => {
@@ -188,14 +219,13 @@ export class MongoSchemaGenerator extends AbstractSchemaGenerator {
                 return o;
             }, {});
             const collection = this.connection.getCollection(meta.class);
-            res.push([
-                collection.collectionName,
-                this.executeQuery(collection, 'createIndex', fieldOrSpec, {
-                    name: index.name,
-                    unique: true,
-                    ...index.options,
-                }),
-            ]);
+            const indexOptions = {
+                name: index.name,
+                unique: true,
+                ...index.options,
+            };
+            this.applyPartialFilter(indexOptions, index.where, index.name, meta.className);
+            res.push([collection.collectionName, this.executeQuery(collection, 'createIndex', fieldOrSpec, indexOptions)]);
         });
         return res;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/mongodb",
-  "version": "7.1.0-dev.13",
+  "version": "7.1.0-dev.15",
   "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",
@@ -53,7 +53,7 @@
     "@mikro-orm/core": "^7.0.11"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.1.0-dev.13"
+    "@mikro-orm/core": "7.1.0-dev.15"
   },
   "engines": {
     "node": ">= 22.17.0"