@mikro-orm/mongodb 7.1.0-dev.31 → 7.1.0-dev.32

package/MongoConnection.d.ts

@@ -28,13 +28,13 @@ export declare class MongoConnection extends Connection {
     find<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, opts?: MongoFindOptions<T>): Promise<EntityData<T>[]>;
     stream<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, opts?: MongoFindOptions<T>): AsyncIterableIterator<T>;
     private _find;
-    insertOne<T extends object>(entityName: EntityName<T>, data: Partial<T>, ctx?: Transaction<ClientSession>): Promise<QueryResult<T>>;
-    insertMany<T extends object>(entityName: EntityName<T>, data: Partial<T>[], ctx?: Transaction<ClientSession>): Promise<QueryResult<T>>;
-    updateMany<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, data: Partial<T>, ctx?: Transaction<ClientSession>, upsert?: boolean, upsertOptions?: UpsertOptions<T>): Promise<QueryResult<T>>;
-    bulkUpdateMany<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>[], data: Partial<T>[], ctx?: Transaction<ClientSession>, upsert?: boolean, upsertOptions?: UpsertManyOptions<T>): Promise<QueryResult<T>>;
-    deleteMany<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, ctx?: Transaction<ClientSession>): Promise<QueryResult<T>>;
-    aggregate<T extends object = any>(entityName: EntityName<T>, pipeline: any[], ctx?: Transaction<ClientSession>, loggerContext?: LoggingOptions): Promise<T[]>;
-    streamAggregate<T extends object>(entityName: EntityName<T>, pipeline: any[], ctx?: Transaction<ClientSession>, loggerContext?: LoggingOptions, stream?: boolean): AsyncIterableIterator<T>;
+    insertOne<T extends object>(entityName: EntityName<T>, data: Partial<T>, ctx?: Transaction<ClientSession>, signal?: AbortSignal): Promise<QueryResult<T>>;
+    insertMany<T extends object>(entityName: EntityName<T>, data: Partial<T>[], ctx?: Transaction<ClientSession>, signal?: AbortSignal): Promise<QueryResult<T>>;
+    updateMany<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, data: Partial<T>, ctx?: Transaction<ClientSession>, upsert?: boolean, upsertOptions?: UpsertOptions<T>, signal?: AbortSignal): Promise<QueryResult<T>>;
+    bulkUpdateMany<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>[], data: Partial<T>[], ctx?: Transaction<ClientSession>, upsert?: boolean, upsertOptions?: UpsertManyOptions<T>, signal?: AbortSignal): Promise<QueryResult<T>>;
+    deleteMany<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, ctx?: Transaction<ClientSession>, signal?: AbortSignal): Promise<QueryResult<T>>;
+    aggregate<T extends object = any>(entityName: EntityName<T>, pipeline: any[], ctx?: Transaction<ClientSession>, loggerContext?: LoggingOptions, signal?: AbortSignal): Promise<T[]>;
+    streamAggregate<T extends object>(entityName: EntityName<T>, pipeline: any[], ctx?: Transaction<ClientSession>, loggerContext?: LoggingOptions, stream?: boolean, signal?: AbortSignal): AsyncIterableIterator<T>;
     countDocuments<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, opts?: MongoCountOptions): Promise<number>;
     transactional<T>(cb: (trx: Transaction<ClientSession>) => Promise<T>, options?: {
         isolationLevel?: IsolationLevel;
@@ -61,6 +61,11 @@ export interface MongoQueryOptions {
     indexHint?: string | Dictionary;
     maxTimeMS?: number;
     allowDiskUse?: boolean;
+    /**
+     * Forwarded to the MongoDB driver. When fired, the driver aborts the in-flight operation
+     * by closing the underlying socket; the rejection reason is `signal.reason`.
+     */
+    signal?: AbortSignal;
 }
 /** Options for MongoDB find operations. */
 export interface MongoFindOptions<T extends object> extends MongoQueryOptions {

package/MongoConnection.js

@@ -146,6 +146,9 @@ export class MongoConnection extends Connection {
         if (opts.chunkSize != null) {
             options.batchSize = opts.chunkSize;
         }
+        if (opts.signal) {
+            options.signal = opts.signal;
+        }
         const resultSet = this.getCollection(entityName).find(where, options);
         let query = `db.getCollection('${collection}').find(${this.logObject(where)}, ${this.logObject(options)})`;
         const orderBy = Utils.asArray(opts.orderBy);
@@ -177,37 +180,43 @@ export class MongoConnection extends Connection {
         }
         return { cursor: resultSet, query };
     }
-    async insertOne(entityName, data, ctx) {
-        return this.runQuery('insertOne', entityName, data, undefined, ctx);
+    async insertOne(entityName, data, ctx, signal) {
+        return this.runQuery('insertOne', entityName, data, undefined, ctx, { signal });
     }
-    async insertMany(entityName, data, ctx) {
-        return this.runQuery('insertMany', entityName, data, undefined, ctx);
+    async insertMany(entityName, data, ctx, signal) {
+        return this.runQuery('insertMany', entityName, data, undefined, ctx, { signal });
     }
-    async updateMany(entityName, where, data, ctx, upsert, upsertOptions) {
-        return this.runQuery('updateMany', entityName, data, where, ctx, { upsert, upsertOptions });
+    async updateMany(entityName, where, data, ctx, upsert, upsertOptions, signal) {
+        return this.runQuery('updateMany', entityName, data, where, ctx, { upsert, upsertOptions, signal });
     }
-    async bulkUpdateMany(entityName, where, data, ctx, upsert, upsertOptions) {
-        return this.runQuery('bulkUpdateMany', entityName, data, where, ctx, { upsert, upsertOptions });
+    async bulkUpdateMany(entityName, where, data, ctx, upsert, upsertOptions, signal) {
+        return this.runQuery('bulkUpdateMany', entityName, data, where, ctx, { upsert, upsertOptions, signal });
     }
-    async deleteMany(entityName, where, ctx) {
-        return this.runQuery('deleteMany', entityName, undefined, where, ctx);
+    async deleteMany(entityName, where, ctx, signal) {
+        return this.runQuery('deleteMany', entityName, undefined, where, ctx, { signal });
     }
-    async aggregate(entityName, pipeline, ctx, loggerContext) {
+    async aggregate(entityName, pipeline, ctx, loggerContext, signal) {
         await this.ensureConnection();
         const collection = this.getCollectionName(entityName);
         /* v8 ignore next */
         const options = ctx ? { session: ctx } : {};
+        if (signal) {
+            options.signal = signal;
+        }
         const query = `db.getCollection('${collection}').aggregate(${this.logObject(pipeline)}, ${this.logObject(options)}).toArray();`;
         const now = Date.now();
         const res = await this.getCollection(entityName).aggregate(pipeline, options).toArray();
         this.logQuery(query, { took: Date.now() - now, results: res.length, ...loggerContext });
         return res;
     }
-    async *streamAggregate(entityName, pipeline, ctx, loggerContext, stream = false) {
+    async *streamAggregate(entityName, pipeline, ctx, loggerContext, stream = false, signal) {
         await this.ensureConnection();
         const collection = this.getCollectionName(entityName);
         /* v8 ignore next */
         const options = ctx ? { session: ctx } : {};
+        if (signal) {
+            options.signal = signal;
+        }
         const query = `db.getCollection('${collection}').aggregate(${this.logObject(pipeline)}, ${this.logObject(options)})};`;
         const cursor = this.getCollection(entityName).aggregate(pipeline, options);
         this.logQuery(query, { ...loggerContext });
@@ -219,6 +228,7 @@ export class MongoConnection extends Connection {
             collation: opts.collation,
             indexHint: opts.indexHint,
             maxTimeMS: opts.maxTimeMS,
+            signal: opts.signal,
         });
     }
     async transactional(cb, options = {}) {
@@ -265,13 +275,16 @@ export class MongoConnection extends Connection {
     }
     async runQuery(method, entityName, data, where, ctx, opts) {
         await this.ensureConnection();
-        const { upsert, upsertOptions, loggerContext, collation, indexHint, maxTimeMS } = opts ?? {};
+        const { upsert, upsertOptions, loggerContext, collation, indexHint, maxTimeMS, signal } = opts ?? {};
         const collection = this.getCollectionName(entityName);
         const logger = this.config.getLogger();
         const options = ctx ? { session: ctx, upsert } : { upsert };
         if (options.upsert === undefined) {
             delete options.upsert;
         }
+        if (signal) {
+            options.signal = signal;
+        }
         const now = Date.now();
         let res;
         let query;

package/MongoDriver.d.ts

@@ -27,9 +27,10 @@ export declare class MongoDriver extends DatabaseDriver<MongoConnection> {
     nativeUpdateMany<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>[], data: EntityDictionary<T>[], options?: NativeInsertUpdateOptions<T> & UpsertManyOptions<T>): Promise<QueryResult<T>>;
     nativeDelete<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, options?: {
         ctx?: Transaction<ClientSession>;
+        signal?: AbortSignal;
     }): Promise<QueryResult<T>>;
-    aggregate(entityName: EntityName, pipeline: any[], ctx?: Transaction<ClientSession>): Promise<any[]>;
-    streamAggregate<T extends object>(entityName: EntityName<T>, pipeline: any[], ctx?: Transaction<ClientSession>): AsyncIterableIterator<T>;
+    aggregate(entityName: EntityName, pipeline: any[], ctx?: Transaction<ClientSession>, signal?: AbortSignal): Promise<any[]>;
+    streamAggregate<T extends object>(entityName: EntityName<T>, pipeline: any[], ctx?: Transaction<ClientSession>, signal?: AbortSignal): AsyncIterableIterator<T>;
     getPlatform(): MongoPlatform;
     private buildQueryOptions;
     /** @internal */

package/MongoDriver.js

@@ -132,7 +132,7 @@ export class MongoDriver extends DatabaseDriver {
             }
             pipeline.push({ $project: projection });
         }
-        const res = await this.rethrow(this.getConnection('read').aggregate(entityName, pipeline, options.ctx, options.logging));
+        const res = await this.rethrow(this.getConnection('read').aggregate(entityName, pipeline, options.ctx, options.logging, options.signal));
         return res.map(r => this.mapResult(r, meta));
     }
     async findOne(entityName, where, options = { populate: [], orderBy: {} }) {
@@ -193,7 +193,7 @@ export class MongoDriver extends DatabaseDriver {
     async nativeInsert(entityName, data, options = {}) {
         this.handleVersionProperty(entityName, data);
         data = this.renameFields(entityName, data);
-        return this.rethrow(this.getConnection('write').insertOne(entityName, data, options.ctx));
+        return this.rethrow(this.getConnection('write').insertOne(entityName, data, options.ctx, options.signal));
     }
     async nativeClone(entityName, where, overrides, options = {}) {
         const meta = this.metadata.find(entityName);
@@ -224,7 +224,7 @@ export class MongoDriver extends DatabaseDriver {
         const meta = this.metadata.find(entityName);
         /* v8 ignore next */
         const pk = meta?.getPrimaryProps()[0].fieldNames[0] ?? '_id';
-        const res = await this.rethrow(this.getConnection('write').insertMany(entityName, data, options.ctx));
+        const res = await this.rethrow(this.getConnection('write').insertMany(entityName, data, options.ctx, options.signal));
         res.rows = res.insertedIds.map(id => ({ [pk]: id }));
         return res;
     }
@@ -248,7 +248,7 @@ export class MongoDriver extends DatabaseDriver {
         if (options.onConflictExcludeFields) {
             options.onConflictExcludeFields = options.onConflictExcludeFields.map(rename);
         }
-        return this.rethrow(this.getConnection('write').updateMany(entityName, where, data, options.ctx, options.upsert, options));
+        return this.rethrow(this.getConnection('write').updateMany(entityName, where, data, options.ctx, options.upsert, options, options.signal));
     }
     async nativeUpdateMany(entityName, where, data, options = {}) {
         where = where.map(row => {
@@ -276,7 +276,7 @@ export class MongoDriver extends DatabaseDriver {
         }
         /* v8 ignore next */
         const pk = meta?.getPrimaryProps()[0].fieldNames[0] ?? '_id';
-        const res = await this.rethrow(this.getConnection('write').bulkUpdateMany(entityName, where, data, options.ctx, options.upsert, options));
+        const res = await this.rethrow(this.getConnection('write').bulkUpdateMany(entityName, where, data, options.ctx, options.upsert, options, options.signal));
         if (res.insertedIds) {
             let i = 0;
             res.rows = where.map(cond => {
@@ -293,13 +293,13 @@ export class MongoDriver extends DatabaseDriver {
             where = this.buildFilterById(entityName, where);
         }
         where = this.renameFields(entityName, where, true);
-        return this.rethrow(this.getConnection('write').deleteMany(entityName, where, options.ctx));
+        return this.rethrow(this.getConnection('write').deleteMany(entityName, where, options.ctx, options.signal));
     }
-    async aggregate(entityName, pipeline, ctx) {
-        return this.rethrow(this.getConnection('read').aggregate(entityName, pipeline, ctx));
+    async aggregate(entityName, pipeline, ctx, signal) {
+        return this.rethrow(this.getConnection('read').aggregate(entityName, pipeline, ctx, undefined, signal));
     }
-    async *streamAggregate(entityName, pipeline, ctx) {
-        yield* this.getConnection('read').streamAggregate(entityName, pipeline, ctx);
+    async *streamAggregate(entityName, pipeline, ctx, signal) {
+        yield* this.getConnection('read').streamAggregate(entityName, pipeline, ctx, undefined, false, signal);
     }
     getPlatform() {
         return this.platform;
@@ -328,6 +328,9 @@ export class MongoDriver extends DatabaseDriver {
         if (options.allowDiskUse != null) {
             ret.allowDiskUse = options.allowDiskUse;
         }
+        if (options.signal) {
+            ret.signal = options.signal;
+        }
         return ret;
     }
     /** @internal */

package/MongoEntityManager.js

@@ -7,13 +7,13 @@ export class MongoEntityManager extends EntityManager {
      * Shortcut to driver's aggregate method. Available in MongoDriver only.
      */
     async aggregate(entityName, pipeline) {
-        return this.getDriver().aggregate(entityName, pipeline, this.getTransactionContext());
+        return this.getDriver().aggregate(entityName, pipeline, this.getTransactionContext(), this.signal);
     }
     /**
      * Shortcut to driver's aggregate method. Returns a stream. Available in MongoDriver only.
      */
     async *streamAggregate(entityName, pipeline) {
-        yield* this.getDriver().streamAggregate(entityName, pipeline, this.getTransactionContext());
+        yield* this.getDriver().streamAggregate(entityName, pipeline, this.getTransactionContext(), this.signal);
     }
     /**
      * @inheritDoc
@@ -50,7 +50,7 @@ export class MongoEntityManager extends EntityManager {
             pipeline.push({ $match: renamedWhere });
         }
         pipeline.push({ $group: { _id: groupId, count: { $sum: 1 } } });
-        const rows = await em.getDriver().aggregate(meta.class, pipeline, em.getTransactionContext());
+        const rows = await em.getDriver().aggregate(meta.class, pipeline, em.getTransactionContext(), em.signal);
         const results = {};
         for (const row of rows) {
             const key = fieldNames.length === 1 ? String(row._id) : fieldNames.map(f => String(row._id[f])).join(Utils.PK_SEPARATOR);

package/package.json

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