import { BSONSerializeOptions, Document, resolveBSONOptions } from './bson'; import type { AnyBulkWriteOperation, BulkWriteOptions, BulkWriteResult } from './bulk/common'; import { OrderedBulkOperation } from './bulk/ordered'; import { UnorderedBulkOperation } from './bulk/unordered'; import { ChangeStream, ChangeStreamDocument, ChangeStreamOptions } from './change_stream'; import { AggregationCursor } from './cursor/aggregation_cursor'; import { FindCursor } from './cursor/find_cursor'; import { ListIndexesCursor } from './cursor/list_indexes_cursor'; import type { Db } from './db'; import { MongoInvalidArgumentError } from './error'; import type { Logger, LoggerOptions } from './logger'; import type { PkFactory } from './mongo_client'; import type { Filter, Flatten, OptionalUnlessRequiredId, TODO_NODE_3286, UpdateFilter, WithId, WithoutId } from './mongo_types'; import type { AggregateOptions } from './operations/aggregate'; import { BulkWriteOperation } from './operations/bulk_write'; import type { IndexInformationOptions } from './operations/common_functions'; import { CountOperation, CountOptions } from './operations/count'; import { CountDocumentsOperation, CountDocumentsOptions } from './operations/count_documents'; import { DeleteManyOperation, DeleteOneOperation, DeleteOptions, DeleteResult } from './operations/delete'; import { DistinctOperation, DistinctOptions } from './operations/distinct'; import { DropCollectionOperation, DropCollectionOptions } from './operations/drop'; import { EstimatedDocumentCountOperation, EstimatedDocumentCountOptions } from './operations/estimated_document_count'; import { executeOperation } from './operations/execute_operation'; import type { FindOptions } from './operations/find'; import { FindOneAndDeleteOperation, FindOneAndDeleteOptions, FindOneAndReplaceOperation, FindOneAndReplaceOptions, FindOneAndUpdateOperation, FindOneAndUpdateOptions } from './operations/find_and_modify'; import { CreateIndexesOperation, CreateIndexesOptions, CreateIndexOperation, DropIndexesOperation, DropIndexesOptions, DropIndexOperation, IndexDescription, IndexesOperation, IndexExistsOperation, IndexInformationOperation, IndexSpecification, ListIndexesOptions } from './operations/indexes'; import { InsertManyOperation, InsertManyResult, InsertOneOperation, InsertOneOptions, InsertOneResult } from './operations/insert'; import { IsCappedOperation } from './operations/is_capped'; import { MapFunction, MapReduceOperation, MapReduceOptions, ReduceFunction } from './operations/map_reduce'; import type { Hint, OperationOptions } from './operations/operation'; import { OptionsOperation } from './operations/options_operation'; import { RenameOperation, RenameOptions } from './operations/rename'; import { CollStats, CollStatsOperation, CollStatsOptions } from './operations/stats'; import { ReplaceOneOperation, ReplaceOptions, UpdateManyOperation, UpdateOneOperation, UpdateOptions, UpdateResult } from './operations/update'; import { ReadConcern, ReadConcernLike } from './read_concern'; import { ReadPreference, ReadPreferenceLike } from './read_preference'; import { Callback, checkCollectionName, DEFAULT_PK_FACTORY, emitWarningOnce, MongoDBNamespace, normalizeHintField, resolveOptions } from './utils'; import { WriteConcern, WriteConcernOptions } from './write_concern'; /** @public */ export interface ModifyResult { value: WithId | null; lastErrorObject?: Document; ok: 0 | 1; } /** @public */ export interface CollectionOptions extends BSONSerializeOptions, WriteConcernOptions, LoggerOptions { /** * @deprecated Use readPreference instead */ slaveOk?: boolean; /** Specify a read concern for the collection. (only MongoDB 3.2 or higher supported) */ readConcern?: ReadConcernLike; /** The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST). */ readPreference?: ReadPreferenceLike; } /** @internal */ export interface CollectionPrivate { pkFactory: PkFactory; db: Db; options: any; namespace: MongoDBNamespace; readPreference?: ReadPreference; bsonOptions: BSONSerializeOptions; collectionHint?: Hint; readConcern?: ReadConcern; writeConcern?: WriteConcern; } /** * The **Collection** class is an internal class that embodies a MongoDB collection * allowing for insert/find/update/delete and other command operation on that MongoDB collection. * * **COLLECTION Cannot directly be instantiated** * @public * * @example * ```ts * import { MongoClient } from 'mongodb'; * * interface Pet { * name: string; * kind: 'dog' | 'cat' | 'fish'; * } * * const client = new MongoClient('mongodb://localhost:27017'); * const pets = client.db().collection('pets'); * * const petCursor = pets.find(); * * for await (const pet of petCursor) { * console.log(`${pet.name} is a ${pet.kind}!`); * } * ``` */ export class Collection { /** @internal */ s: CollectionPrivate; /** * Create a new Collection instance * @internal */ constructor(db: Db, name: string, options?: CollectionOptions) { checkCollectionName(name); // Internal state this.s = { db, options, namespace: new MongoDBNamespace(db.databaseName, name), pkFactory: db.options?.pkFactory ?? DEFAULT_PK_FACTORY, readPreference: ReadPreference.fromOptions(options), bsonOptions: resolveBSONOptions(options, db), readConcern: ReadConcern.fromOptions(options), writeConcern: WriteConcern.fromOptions(options) }; } /** * The name of the database this collection belongs to */ get dbName(): string { return this.s.namespace.db; } /** * The name of this collection */ get collectionName(): string { // eslint-disable-next-line @typescript-eslint/no-non-null-assertion return this.s.namespace.collection!; } /** * The namespace of this collection, in the format `${this.dbName}.${this.collectionName}` */ get namespace(): string { return this.s.namespace.toString(); } /** * The current readConcern of the collection. If not explicitly defined for * this collection, will be inherited from the parent DB */ get readConcern(): ReadConcern | undefined { if (this.s.readConcern == null) { return this.s.db.readConcern; } return this.s.readConcern; } /** * The current readPreference of the collection. If not explicitly defined for * this collection, will be inherited from the parent DB */ get readPreference(): ReadPreference | undefined { if (this.s.readPreference == null) { return this.s.db.readPreference; } return this.s.readPreference; } get bsonOptions(): BSONSerializeOptions { return this.s.bsonOptions; } /** * The current writeConcern of the collection. If not explicitly defined for * this collection, will be inherited from the parent DB */ get writeConcern(): WriteConcern | undefined { if (this.s.writeConcern == null) { return this.s.db.writeConcern; } return this.s.writeConcern; } /** The current index hint for the collection */ get hint(): Hint | undefined { return this.s.collectionHint; } set hint(v: Hint | undefined) { this.s.collectionHint = normalizeHintField(v); } /** * Inserts a single document into MongoDB. If documents passed in do not contain the **_id** field, * one will be added to each of the documents missing it by the driver, mutating the document. This behavior * can be overridden by setting the **forceServerObjectId** flag. * * @param doc - The document to insert * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ insertOne(doc: OptionalUnlessRequiredId): Promise>; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ insertOne( doc: OptionalUnlessRequiredId, callback: Callback> ): void; insertOne( doc: OptionalUnlessRequiredId, options: InsertOneOptions ): Promise>; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ insertOne( doc: OptionalUnlessRequiredId, options: InsertOneOptions, callback: Callback> ): void; insertOne( doc: OptionalUnlessRequiredId, options?: InsertOneOptions | Callback>, callback?: Callback> ): Promise> | void { if (typeof options === 'function') { callback = options; options = {}; } // CSFLE passes in { w: 'majority' } to ensure the lib works in both 3.x and 4.x // we support that option style here only if (options && Reflect.get(options, 'w')) { options.writeConcern = WriteConcern.fromOptions(Reflect.get(options, 'w')); } return executeOperation( this.s.db.s.client, new InsertOneOperation( this as TODO_NODE_3286, doc, resolveOptions(this, options) ) as TODO_NODE_3286, callback ); } /** * Inserts an array of documents into MongoDB. If documents passed in do not contain the **_id** field, * one will be added to each of the documents missing it by the driver, mutating the document. This behavior * can be overridden by setting the **forceServerObjectId** flag. * * @param docs - The documents to insert * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ insertMany(docs: OptionalUnlessRequiredId[]): Promise>; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ insertMany( docs: OptionalUnlessRequiredId[], callback: Callback> ): void; insertMany( docs: OptionalUnlessRequiredId[], options: BulkWriteOptions ): Promise>; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ insertMany( docs: OptionalUnlessRequiredId[], options: BulkWriteOptions, callback: Callback> ): void; insertMany( docs: OptionalUnlessRequiredId[], options?: BulkWriteOptions | Callback>, callback?: Callback> ): Promise> | void { if (typeof options === 'function') (callback = options), (options = {}); options = options ? Object.assign({}, options) : { ordered: true }; return executeOperation( this.s.db.s.client, new InsertManyOperation( this as TODO_NODE_3286, docs, resolveOptions(this, options) ) as TODO_NODE_3286, callback ); } /** * Perform a bulkWrite operation without a fluent API * * Legal operation types are * - `insertOne` * - `replaceOne` * - `updateOne` * - `updateMany` * - `deleteOne` * - `deleteMany` * * Please note that raw operations are no longer accepted as of driver version 4.0. * * If documents passed in do not contain the **_id** field, * one will be added to each of the documents missing it by the driver, mutating the document. This behavior * can be overridden by setting the **forceServerObjectId** flag. * * @param operations - Bulk operations to perform * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided * @throws MongoDriverError if operations is not an array */ bulkWrite(operations: AnyBulkWriteOperation[]): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ bulkWrite( operations: AnyBulkWriteOperation[], callback: Callback ): void; bulkWrite( operations: AnyBulkWriteOperation[], options: BulkWriteOptions ): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ bulkWrite( operations: AnyBulkWriteOperation[], options: BulkWriteOptions, callback: Callback ): void; bulkWrite( operations: AnyBulkWriteOperation[], options?: BulkWriteOptions | Callback, callback?: Callback ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); options = options || { ordered: true }; if (!Array.isArray(operations)) { throw new MongoInvalidArgumentError('Argument "operations" must be an array of documents'); } return executeOperation( this.s.db.s.client, new BulkWriteOperation( this as TODO_NODE_3286, operations as TODO_NODE_3286, resolveOptions(this, options) ), callback ); } /** * Update a single document in a collection * * @param filter - The filter used to select the document to update * @param update - The update operations to be applied to the document * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ updateOne( filter: Filter, update: UpdateFilter | Partial ): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ updateOne( filter: Filter, update: UpdateFilter | Partial, callback: Callback ): void; updateOne( filter: Filter, update: UpdateFilter | Partial, options: UpdateOptions ): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ updateOne( filter: Filter, update: UpdateFilter | Partial, options: UpdateOptions, callback: Callback ): void; updateOne( filter: Filter, update: UpdateFilter | Partial, options?: UpdateOptions | Callback, callback?: Callback ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); return executeOperation( this.s.db.s.client, new UpdateOneOperation( this as TODO_NODE_3286, filter, update, resolveOptions(this, options) ) as TODO_NODE_3286, callback ); } /** * Replace a document in a collection with another document * * @param filter - The filter used to select the document to replace * @param replacement - The Document that replaces the matching document * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ replaceOne( filter: Filter, replacement: WithoutId ): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ replaceOne( filter: Filter, replacement: WithoutId, callback: Callback ): void; replaceOne( filter: Filter, replacement: WithoutId, options: ReplaceOptions ): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ replaceOne( filter: Filter, replacement: WithoutId, options: ReplaceOptions, callback: Callback ): void; replaceOne( filter: Filter, replacement: WithoutId, options?: ReplaceOptions | Callback, callback?: Callback ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); return executeOperation( this.s.db.s.client, new ReplaceOneOperation( this as TODO_NODE_3286, filter, replacement, resolveOptions(this, options) ), callback ); } /** * Update multiple documents in a collection * * @param filter - The filter used to select the documents to update * @param update - The update operations to be applied to the documents * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ updateMany( filter: Filter, update: UpdateFilter ): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ updateMany( filter: Filter, update: UpdateFilter, callback: Callback ): void; updateMany( filter: Filter, update: UpdateFilter, options: UpdateOptions ): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ updateMany( filter: Filter, update: UpdateFilter, options: UpdateOptions, callback: Callback ): void; updateMany( filter: Filter, update: UpdateFilter, options?: UpdateOptions | Callback, callback?: Callback ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); return executeOperation( this.s.db.s.client, new UpdateManyOperation( this as TODO_NODE_3286, filter, update, resolveOptions(this, options) ), callback ); } /** * Delete a document from a collection * * @param filter - The filter used to select the document to remove * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ deleteOne(filter: Filter): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ deleteOne(filter: Filter, callback: Callback): void; deleteOne(filter: Filter, options: DeleteOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ deleteOne( filter: Filter, options: DeleteOptions, callback?: Callback ): void; deleteOne( filter: Filter, options?: DeleteOptions | Callback, callback?: Callback ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); return executeOperation( this.s.db.s.client, new DeleteOneOperation(this as TODO_NODE_3286, filter, resolveOptions(this, options)), callback ); } /** * Delete multiple documents from a collection * * @param filter - The filter used to select the documents to remove * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ deleteMany(filter: Filter): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ deleteMany(filter: Filter, callback: Callback): void; deleteMany(filter: Filter, options: DeleteOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ deleteMany( filter: Filter, options: DeleteOptions, callback: Callback ): void; deleteMany( filter: Filter, options?: DeleteOptions | Callback, callback?: Callback ): Promise | void { if (filter == null) { filter = {}; options = {}; callback = undefined; } else if (typeof filter === 'function') { callback = filter as Callback; filter = {}; options = {}; } else if (typeof options === 'function') { callback = options; options = {}; } return executeOperation( this.s.db.s.client, new DeleteManyOperation(this as TODO_NODE_3286, filter, resolveOptions(this, options)), callback ); } /** * Rename the collection. * * @remarks * This operation does not inherit options from the Db or MongoClient. * * @param newName - New name of of the collection. * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ rename(newName: string): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ rename(newName: string, callback: Callback): void; rename(newName: string, options: RenameOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ rename(newName: string, options: RenameOptions, callback: Callback): void; rename( newName: string, options?: RenameOptions | Callback, callback?: Callback ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); // Intentionally, we do not inherit options from parent for this operation. return executeOperation( this.s.db.s.client, new RenameOperation(this as TODO_NODE_3286, newName, { ...options, readPreference: ReadPreference.PRIMARY }), callback ); } /** * Drop the collection from the database, removing it permanently. New accesses will create a new collection. * * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ drop(): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ drop(callback: Callback): void; drop(options: DropCollectionOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ drop(options: DropCollectionOptions, callback: Callback): void; drop( options?: DropCollectionOptions | Callback, callback?: Callback ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); options = options ?? {}; return executeOperation( this.s.db.s.client, new DropCollectionOperation(this.s.db, this.collectionName, options), callback ); } /** * Fetches the first document that matches the filter * * @param filter - Query for find Operation * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ findOne(): Promise | null>; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ findOne(callback: Callback | null>): void; findOne(filter: Filter): Promise | null>; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ findOne(filter: Filter, callback: Callback | null>): void; findOne(filter: Filter, options: FindOptions): Promise | null>; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ findOne( filter: Filter, options: FindOptions, callback: Callback | null> ): void; // allow an override of the schema. findOne(): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ findOne(callback: Callback): void; findOne(filter: Filter): Promise; findOne(filter: Filter, options?: FindOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ findOne( filter: Filter, options?: FindOptions, callback?: Callback ): void; findOne( filter?: Filter | Callback | null>, options?: FindOptions | Callback | null>, callback?: Callback | null> ): Promise | null> | void { if (callback != null && typeof callback !== 'function') { throw new MongoInvalidArgumentError( 'Third parameter to `findOne()` must be a callback or undefined' ); } if (typeof filter === 'function') { callback = filter; filter = {}; options = {}; } if (typeof options === 'function') { callback = options; options = {}; } const finalFilter = filter ?? {}; const finalOptions = options ?? {}; return this.find(finalFilter, finalOptions).limit(-1).batchSize(1).next(callback); } /** * Creates a cursor for a filter that can be used to iterate over results from MongoDB * * @param filter - The filter predicate. If unspecified, then all documents in the collection will match the predicate */ find(): FindCursor>; find(filter: Filter, options?: FindOptions): FindCursor>; find(filter: Filter, options?: FindOptions): FindCursor; find(filter?: Filter, options?: FindOptions): FindCursor> { if (arguments.length > 2) { throw new MongoInvalidArgumentError( 'Method "collection.find()" accepts at most two arguments' ); } if (typeof options === 'function') { throw new MongoInvalidArgumentError('Argument "options" must not be function'); } return new FindCursor>( this.s.db.s.client, this.s.namespace, filter, resolveOptions(this as TODO_NODE_3286, options) ); } /** * Returns the options of the collection. * * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ options(): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ options(callback: Callback): void; options(options: OperationOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ options(options: OperationOptions, callback: Callback): void; options( options?: OperationOptions | Callback, callback?: Callback ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); return executeOperation( this.s.db.s.client, new OptionsOperation(this as TODO_NODE_3286, resolveOptions(this, options)), callback ); } /** * Returns if the collection is a capped collection * * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ isCapped(): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ isCapped(callback: Callback): void; isCapped(options: OperationOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ isCapped(options: OperationOptions, callback: Callback): void; isCapped( options?: OperationOptions | Callback, callback?: Callback ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); return executeOperation( this.s.db.s.client, new IsCappedOperation(this as TODO_NODE_3286, resolveOptions(this, options)), callback ); } /** * Creates an index on the db and collection collection. * * @param indexSpec - The field name or index specification to create an index for * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided * * @example * ```ts * const collection = client.db('foo').collection('bar'); * * await collection.createIndex({ a: 1, b: -1 }); * * // Alternate syntax for { c: 1, d: -1 } that ensures order of indexes * await collection.createIndex([ [c, 1], [d, -1] ]); * * // Equivalent to { e: 1 } * await collection.createIndex('e'); * * // Equivalent to { f: 1, g: 1 } * await collection.createIndex(['f', 'g']) * * // Equivalent to { h: 1, i: -1 } * await collection.createIndex([ { h: 1 }, { i: -1 } ]); * * // Equivalent to { j: 1, k: -1, l: 2d } * await collection.createIndex(['j', ['k', -1], { l: '2d' }]) * ``` */ createIndex(indexSpec: IndexSpecification): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ createIndex(indexSpec: IndexSpecification, callback: Callback): void; createIndex(indexSpec: IndexSpecification, options: CreateIndexesOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ createIndex( indexSpec: IndexSpecification, options: CreateIndexesOptions, callback: Callback ): void; createIndex( indexSpec: IndexSpecification, options?: CreateIndexesOptions | Callback, callback?: Callback ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); return executeOperation( this.s.db.s.client, new CreateIndexOperation( this as TODO_NODE_3286, this.collectionName, indexSpec, resolveOptions(this, options) ), callback ); } /** * Creates multiple indexes in the collection, this method is only supported for * MongoDB 2.6 or higher. Earlier version of MongoDB will throw a command not supported * error. * * **Note**: Unlike {@link Collection#createIndex| createIndex}, this function takes in raw index specifications. * Index specifications are defined {@link http://docs.mongodb.org/manual/reference/command/createIndexes/| here}. * * @param indexSpecs - An array of index specifications to be created * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided * * @example * ```ts * const collection = client.db('foo').collection('bar'); * await collection.createIndexes([ * // Simple index on field fizz * { * key: { fizz: 1 }, * } * // wildcard index * { * key: { '$**': 1 } * }, * // named index on darmok and jalad * { * key: { darmok: 1, jalad: -1 } * name: 'tanagra' * } * ]); * ``` */ createIndexes(indexSpecs: IndexDescription[]): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ createIndexes(indexSpecs: IndexDescription[], callback: Callback): void; createIndexes(indexSpecs: IndexDescription[], options: CreateIndexesOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ createIndexes( indexSpecs: IndexDescription[], options: CreateIndexesOptions, callback: Callback ): void; createIndexes( indexSpecs: IndexDescription[], options?: CreateIndexesOptions | Callback, callback?: Callback ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); options = options ? Object.assign({}, options) : {}; if (typeof options.maxTimeMS !== 'number') delete options.maxTimeMS; return executeOperation( this.s.db.s.client, new CreateIndexesOperation( this as TODO_NODE_3286, this.collectionName, indexSpecs, resolveOptions(this, options) ), callback ); } /** * Drops an index from this collection. * * @param indexName - Name of the index to drop. * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ dropIndex(indexName: string): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ dropIndex(indexName: string, callback: Callback): void; dropIndex(indexName: string, options: DropIndexesOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ dropIndex(indexName: string, options: DropIndexesOptions, callback: Callback): void; dropIndex( indexName: string, options?: DropIndexesOptions | Callback, callback?: Callback ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); options = resolveOptions(this, options); // Run only against primary options.readPreference = ReadPreference.primary; return executeOperation( this.s.db.s.client, new DropIndexOperation(this as TODO_NODE_3286, indexName, options), callback ); } /** * Drops all indexes from this collection. * * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ dropIndexes(): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ dropIndexes(callback: Callback): void; dropIndexes(options: DropIndexesOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ dropIndexes(options: DropIndexesOptions, callback: Callback): void; dropIndexes( options?: DropIndexesOptions | Callback, callback?: Callback ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); return executeOperation( this.s.db.s.client, new DropIndexesOperation(this as TODO_NODE_3286, resolveOptions(this, options)), callback ); } /** * Get the list of all indexes information for the collection. * * @param options - Optional settings for the command */ listIndexes(options?: ListIndexesOptions): ListIndexesCursor { return new ListIndexesCursor(this as TODO_NODE_3286, resolveOptions(this, options)); } /** * Checks if one or more indexes exist on the collection, fails on first non-existing index * * @param indexes - One or more index names to check. * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ indexExists(indexes: string | string[]): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ indexExists(indexes: string | string[], callback: Callback): void; indexExists(indexes: string | string[], options: IndexInformationOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ indexExists( indexes: string | string[], options: IndexInformationOptions, callback: Callback ): void; indexExists( indexes: string | string[], options?: IndexInformationOptions | Callback, callback?: Callback ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); return executeOperation( this.s.db.s.client, new IndexExistsOperation(this as TODO_NODE_3286, indexes, resolveOptions(this, options)), callback ); } /** * Retrieves this collections index info. * * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ indexInformation(): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ indexInformation(callback: Callback): void; indexInformation(options: IndexInformationOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ indexInformation(options: IndexInformationOptions, callback: Callback): void; indexInformation( options?: IndexInformationOptions | Callback, callback?: Callback ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); return executeOperation( this.s.db.s.client, new IndexInformationOperation(this.s.db, this.collectionName, resolveOptions(this, options)), callback ); } /** * Gets an estimate of the count of documents in a collection using collection metadata. * This will always run a count command on all server versions. * * due to an oversight in versions 5.0.0-5.0.8 of MongoDB, the count command, * which estimatedDocumentCount uses in its implementation, was not included in v1 of * the Stable API, and so users of the Stable API with estimatedDocumentCount are * recommended to upgrade their server version to 5.0.9+ or set apiStrict: false to avoid * encountering errors. * * @see {@link https://www.mongodb.com/docs/manual/reference/command/count/#behavior|Count: Behavior} * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ estimatedDocumentCount(): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ estimatedDocumentCount(callback: Callback): void; estimatedDocumentCount(options: EstimatedDocumentCountOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ estimatedDocumentCount(options: EstimatedDocumentCountOptions, callback: Callback): void; estimatedDocumentCount( options?: EstimatedDocumentCountOptions | Callback, callback?: Callback ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); return executeOperation( this.s.db.s.client, new EstimatedDocumentCountOperation(this as TODO_NODE_3286, resolveOptions(this, options)), callback ); } /** * Gets the number of documents matching the filter. * For a fast count of the total documents in a collection see {@link Collection#estimatedDocumentCount| estimatedDocumentCount}. * **Note**: When migrating from {@link Collection#count| count} to {@link Collection#countDocuments| countDocuments} * the following query operators must be replaced: * * | Operator | Replacement | * | -------- | ----------- | * | `$where` | [`$expr`][1] | * | `$near` | [`$geoWithin`][2] with [`$center`][3] | * | `$nearSphere` | [`$geoWithin`][2] with [`$centerSphere`][4] | * * [1]: https://docs.mongodb.com/manual/reference/operator/query/expr/ * [2]: https://docs.mongodb.com/manual/reference/operator/query/geoWithin/ * [3]: https://docs.mongodb.com/manual/reference/operator/query/center/#op._S_center * [4]: https://docs.mongodb.com/manual/reference/operator/query/centerSphere/#op._S_centerSphere * * @param filter - The filter for the count * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided * * @see https://docs.mongodb.com/manual/reference/operator/query/expr/ * @see https://docs.mongodb.com/manual/reference/operator/query/geoWithin/ * @see https://docs.mongodb.com/manual/reference/operator/query/center/#op._S_center * @see https://docs.mongodb.com/manual/reference/operator/query/centerSphere/#op._S_centerSphere */ countDocuments(): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ countDocuments(callback: Callback): void; countDocuments(filter: Filter): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ countDocuments(callback: Callback): void; countDocuments(filter: Filter, options: CountDocumentsOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ countDocuments( filter: Filter, options: CountDocumentsOptions, callback: Callback ): void; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ countDocuments(filter: Filter, callback: Callback): void; countDocuments( filter?: Document | CountDocumentsOptions | Callback, options?: CountDocumentsOptions | Callback, callback?: Callback ): Promise | void { if (filter == null) { (filter = {}), (options = {}), (callback = undefined); } else if (typeof filter === 'function') { (callback = filter as Callback), (filter = {}), (options = {}); } else { if (arguments.length === 2) { if (typeof options === 'function') (callback = options), (options = {}); } } filter ??= {}; return executeOperation( this.s.db.s.client, new CountDocumentsOperation( this as TODO_NODE_3286, filter, resolveOptions(this, options as CountDocumentsOptions) ), callback ); } /** * The distinct command returns a list of distinct values for the given key across a collection. * * @param key - Field of the document to find distinct values for * @param filter - The filter for filtering the set of documents to which we apply the distinct filter. * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ distinct>( key: Key ): Promise[Key]>>>; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ distinct>( key: Key, callback: Callback[Key]>>> ): void; distinct>( key: Key, filter: Filter ): Promise[Key]>>>; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ distinct>( key: Key, filter: Filter, callback: Callback[Key]>>> ): void; distinct>( key: Key, filter: Filter, options: DistinctOptions ): Promise[Key]>>>; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ distinct>( key: Key, filter: Filter, options: DistinctOptions, callback: Callback[Key]>>> ): void; // Embedded documents overload distinct(key: string): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ distinct(key: string, callback: Callback): void; distinct(key: string, filter: Filter): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ distinct(key: string, filter: Filter, callback: Callback): void; distinct(key: string, filter: Filter, options: DistinctOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ distinct( key: string, filter: Filter, options: DistinctOptions, callback: Callback ): void; // Implementation distinct>( key: Key, filter?: Filter | DistinctOptions | Callback, options?: DistinctOptions | Callback, callback?: Callback ): Promise | void { if (typeof filter === 'function') { (callback = filter), (filter = {}), (options = {}); } else { if (arguments.length === 3 && typeof options === 'function') { (callback = options), (options = {}); } } filter ??= {}; return executeOperation( this.s.db.s.client, new DistinctOperation( this as TODO_NODE_3286, key as TODO_NODE_3286, filter, resolveOptions(this, options as DistinctOptions) ), callback ); } /** * Retrieve all the indexes on the collection. * * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ indexes(): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ indexes(callback: Callback): void; indexes(options: IndexInformationOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ indexes(options: IndexInformationOptions, callback: Callback): void; indexes( options?: IndexInformationOptions | Callback, callback?: Callback ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); return executeOperation( this.s.db.s.client, new IndexesOperation(this as TODO_NODE_3286, resolveOptions(this, options)), callback ); } /** * Get all the collection statistics. * * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ stats(): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ stats(callback: Callback): void; stats(options: CollStatsOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ stats(options: CollStatsOptions, callback: Callback): void; stats( options?: CollStatsOptions | Callback, callback?: Callback ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); options = options ?? {}; return executeOperation( this.s.db.s.client, new CollStatsOperation(this as TODO_NODE_3286, options), callback ); } /** * Find a document and delete it in one atomic operation. Requires a write lock for the duration of the operation. * * @param filter - The filter used to select the document to remove * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ findOneAndDelete(filter: Filter): Promise>; findOneAndDelete( filter: Filter, options: FindOneAndDeleteOptions ): Promise>; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ findOneAndDelete(filter: Filter, callback: Callback>): void; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ findOneAndDelete( filter: Filter, options: FindOneAndDeleteOptions, callback: Callback> ): void; findOneAndDelete( filter: Filter, options?: FindOneAndDeleteOptions | Callback>, callback?: Callback> ): Promise | void { if (typeof options === 'function') (callback = options), (options = {}); return executeOperation( this.s.db.s.client, new FindOneAndDeleteOperation( this as TODO_NODE_3286, filter, resolveOptions(this, options) ) as TODO_NODE_3286, callback ); } /** * Find a document and replace it in one atomic operation. Requires a write lock for the duration of the operation. * * @param filter - The filter used to select the document to replace * @param replacement - The Document that replaces the matching document * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ findOneAndReplace( filter: Filter, replacement: WithoutId ): Promise>; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ findOneAndReplace( filter: Filter, replacement: WithoutId, callback: Callback> ): void; findOneAndReplace( filter: Filter, replacement: WithoutId, options: FindOneAndReplaceOptions ): Promise>; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ findOneAndReplace( filter: Filter, replacement: WithoutId, options: FindOneAndReplaceOptions, callback: Callback> ): void; findOneAndReplace( filter: Filter, replacement: WithoutId, options?: FindOneAndReplaceOptions | Callback>, callback?: Callback> ): Promise> | void { if (typeof options === 'function') (callback = options), (options = {}); return executeOperation( this.s.db.s.client, new FindOneAndReplaceOperation( this as TODO_NODE_3286, filter, replacement, resolveOptions(this, options) ) as TODO_NODE_3286, callback ); } /** * Find a document and update it in one atomic operation. Requires a write lock for the duration of the operation. * * @param filter - The filter used to select the document to update * @param update - Update operations to be performed on the document * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ findOneAndUpdate( filter: Filter, update: UpdateFilter ): Promise>; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ findOneAndUpdate( filter: Filter, update: UpdateFilter, callback: Callback> ): void; findOneAndUpdate( filter: Filter, update: UpdateFilter, options: FindOneAndUpdateOptions ): Promise>; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ findOneAndUpdate( filter: Filter, update: UpdateFilter, options: FindOneAndUpdateOptions, callback: Callback> ): void; findOneAndUpdate( filter: Filter, update: UpdateFilter, options?: FindOneAndUpdateOptions | Callback>, callback?: Callback> ): Promise> | void { if (typeof options === 'function') (callback = options), (options = {}); return executeOperation( this.s.db.s.client, new FindOneAndUpdateOperation( this as TODO_NODE_3286, filter, update, resolveOptions(this, options) ) as TODO_NODE_3286, callback ); } /** * Execute an aggregation framework pipeline against the collection, needs MongoDB \>= 2.2 * * @param pipeline - An array of aggregation pipelines to execute * @param options - Optional settings for the command */ aggregate( pipeline: Document[] = [], options?: AggregateOptions ): AggregationCursor { if (arguments.length > 2) { throw new MongoInvalidArgumentError( 'Method "collection.aggregate()" accepts at most two arguments' ); } if (!Array.isArray(pipeline)) { throw new MongoInvalidArgumentError( 'Argument "pipeline" must be an array of aggregation stages' ); } if (typeof options === 'function') { throw new MongoInvalidArgumentError('Argument "options" must not be function'); } return new AggregationCursor( this.s.db.s.client, this.s.namespace, pipeline, resolveOptions(this, options) ); } /** * Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this collection. * * @remarks * watch() accepts two generic arguments for distinct usecases: * - The first is to override the schema that may be defined for this specific collection * - The second is to override the shape of the change stream document entirely, if it is not provided the type will default to ChangeStreamDocument of the first argument * @example * By just providing the first argument I can type the change to be `ChangeStreamDocument<{ _id: number }>` * ```ts * collection.watch<{ _id: number }>() * .on('change', change => console.log(change._id.toFixed(4))); * ``` * * @example * Passing a second argument provides a way to reflect the type changes caused by an advanced pipeline. * Here, we are using a pipeline to have MongoDB filter for insert changes only and add a comment. * No need start from scratch on the ChangeStreamInsertDocument type! * By using an intersection we can save time and ensure defaults remain the same type! * ```ts * collection * .watch & { comment: string }>([ * { $addFields: { comment: 'big changes' } }, * { $match: { operationType: 'insert' } } * ]) * .on('change', change => { * change.comment.startsWith('big'); * change.operationType === 'insert'; * // No need to narrow in code because the generics did that for us! * expectType(change.fullDocument); * }); * ``` * * @param pipeline - An array of {@link https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents. * @param options - Optional settings for the command * @typeParam TLocal - Type of the data being detected by the change stream * @typeParam TChange - Type of the whole change stream document emitted */ watch>( pipeline: Document[] = [], options: ChangeStreamOptions = {} ): ChangeStream { // Allow optionally not specifying a pipeline if (!Array.isArray(pipeline)) { options = pipeline; pipeline = []; } return new ChangeStream(this, pipeline, resolveOptions(this, options)); } /** * Run Map Reduce across a collection. Be aware that the inline option for out will return an array of results not a collection. * * @deprecated collection.mapReduce is deprecated. Use the aggregation pipeline instead. Visit https://docs.mongodb.com/manual/reference/map-reduce-to-aggregation-pipeline for more information on how to translate map-reduce operations to the aggregation pipeline. * @param map - The mapping function. * @param reduce - The reduce function. * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ mapReduce( map: string | MapFunction, reduce: string | ReduceFunction ): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ mapReduce( map: string | MapFunction, reduce: string | ReduceFunction, callback: Callback ): void; mapReduce( map: string | MapFunction, reduce: string | ReduceFunction, options: MapReduceOptions ): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ mapReduce( map: string | MapFunction, reduce: string | ReduceFunction, options: MapReduceOptions, callback: Callback ): void; mapReduce( map: string | MapFunction, reduce: string | ReduceFunction, options?: MapReduceOptions | Callback, callback?: Callback ): Promise | void { emitWarningOnce( 'collection.mapReduce is deprecated. Use the aggregation pipeline instead. Visit https://docs.mongodb.com/manual/reference/map-reduce-to-aggregation-pipeline for more information on how to translate map-reduce operations to the aggregation pipeline.' ); if ('function' === typeof options) (callback = options), (options = {}); // Out must always be defined (make sure we don't break weirdly on pre 1.8+ servers) // TODO NODE-3339: Figure out if this is still necessary given we no longer officially support pre-1.8 if (options?.out == null) { throw new MongoInvalidArgumentError( 'Option "out" must be defined, see mongodb docs for possible values' ); } if ('function' === typeof map) { map = map.toString(); } if ('function' === typeof reduce) { reduce = reduce.toString(); } if ('function' === typeof options.finalize) { options.finalize = options.finalize.toString(); } return executeOperation( this.s.db.s.client, new MapReduceOperation( this as TODO_NODE_3286, map, reduce, resolveOptions(this, options) as TODO_NODE_3286 ), callback ); } /** * Initiate an Out of order batch write operation. All operations will be buffered into insert/update/remove commands executed out of order. * * @throws MongoNotConnectedError * @remarks * **NOTE:** MongoClient must be connected prior to calling this method due to a known limitation in this legacy implemenation. * However, `collection.bulkWrite()` provides an equivalent API that does not require prior connecting. */ initializeUnorderedBulkOp(options?: BulkWriteOptions): UnorderedBulkOperation { return new UnorderedBulkOperation(this as TODO_NODE_3286, resolveOptions(this, options)); } /** * Initiate an In order bulk write operation. Operations will be serially executed in the order they are added, creating a new operation for each switch in types. * * @throws MongoNotConnectedError * @remarks * **NOTE:** MongoClient must be connected prior to calling this method due to a known limitation in this legacy implemenation. * However, `collection.bulkWrite()` provides an equivalent API that does not require prior connecting. */ initializeOrderedBulkOp(options?: BulkWriteOptions): OrderedBulkOperation { return new OrderedBulkOperation(this as TODO_NODE_3286, resolveOptions(this, options)); } /** Get the db scoped logger */ getLogger(): Logger { return this.s.db.s.logger; } get logger(): Logger { return this.s.db.s.logger; } /** * Inserts a single document or a an array of documents into MongoDB. If documents passed in do not contain the **_id** field, * one will be added to each of the documents missing it by the driver, mutating the document. This behavior * can be overridden by setting the **forceServerObjectId** flag. * * @deprecated Use insertOne, insertMany or bulkWrite instead. Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance * @param docs - The documents to insert * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ insert( docs: OptionalUnlessRequiredId[], options: BulkWriteOptions, callback: Callback> ): Promise> | void { emitWarningOnce( 'collection.insert is deprecated. Use insertOne, insertMany or bulkWrite instead.' ); if (typeof options === 'function') (callback = options), (options = {}); options = options || { ordered: false }; docs = !Array.isArray(docs) ? [docs] : docs; if (options.keepGoing === true) { options.ordered = false; } return this.insertMany(docs, options, callback); } /** * Updates documents. * * @deprecated use updateOne, updateMany or bulkWrite. Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance * @param filter - The filter for the update operation. * @param update - The update operations to be applied to the documents * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ update( filter: Filter, update: UpdateFilter, options: UpdateOptions, callback: Callback ): Promise | void { emitWarningOnce( 'collection.update is deprecated. Use updateOne, updateMany, or bulkWrite instead.' ); if (typeof options === 'function') (callback = options), (options = {}); options = options ?? {}; return this.updateMany(filter, update, options, callback); } /** * Remove documents. * * @deprecated use deleteOne, deleteMany or bulkWrite. Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance * @param filter - The filter for the remove operation. * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ remove( filter: Filter, options: DeleteOptions, callback: Callback ): Promise | void { emitWarningOnce( 'collection.remove is deprecated. Use deleteOne, deleteMany, or bulkWrite instead.' ); if (typeof options === 'function') (callback = options), (options = {}); options = options ?? {}; return this.deleteMany(filter, options, callback); } /** * An estimated count of matching documents in the db to a filter. * * **NOTE:** This method has been deprecated, since it does not provide an accurate count of the documents * in a collection. To obtain an accurate count of documents in the collection, use {@link Collection#countDocuments| countDocuments}. * To obtain an estimated count of all documents in the collection, use {@link Collection#estimatedDocumentCount| estimatedDocumentCount}. * * @deprecated use {@link Collection#countDocuments| countDocuments} or {@link Collection#estimatedDocumentCount| estimatedDocumentCount} instead * * @param filter - The filter for the count. * @param options - Optional settings for the command * @param callback - An optional callback, a Promise will be returned if none is provided */ count(): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ count(callback: Callback): void; count(filter: Filter): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ count(filter: Filter, callback: Callback): void; count(filter: Filter, options: CountOptions): Promise; /** @deprecated Callbacks are deprecated and will be removed in the next major version. See [mongodb-legacy](https://github.com/mongodb-js/nodejs-mongodb-legacy) for migration assistance */ count( filter: Filter, options: CountOptions, callback: Callback ): Promise | void; count( filter?: Filter | CountOptions | Callback, options?: CountOptions | Callback, callback?: Callback ): Promise | void { if (typeof filter === 'function') { (callback = filter), (filter = {}), (options = {}); } else { if (typeof options === 'function') (callback = options), (options = {}); } filter ??= {}; return executeOperation( this.s.db.s.client, new CountOperation( MongoDBNamespace.fromString(this.namespace), filter, resolveOptions(this, options) ), callback ); } }