Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Collection<TSchema>

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

example
import { MongoClient } from 'mongodb';

interface Pet {
  name: string;
  kind: 'dog' | 'cat' | 'fish';
}

const client = new MongoClient('mongodb://localhost:27017');
const pets = client.db().collection<Pet>('pets');

const petCursor = pets.find();

for await (const pet of petCursor) {
  console.log(`${pet.name} is a ${pet.kind}!`);
}

Type parameters

Hierarchy

  • Collection

Index

Accessors

Methods

Accessors

bsonOptions

collectionName

  • get collectionName(): string

dbName

  • get dbName(): string

hint

  • get hint(): undefined | Hint
  • set hint(v: undefined | Hint): void

namespace

  • get namespace(): string

  • The namespace of this collection, in the format ${this.dbName}.${this.collectionName}

    Returns string

readConcern

  • The current readConcern of the collection. If not explicitly defined for this collection, will be inherited from the parent DB

    Returns undefined | ReadConcern

readPreference

  • The current readPreference of the collection. If not explicitly defined for this collection, will be inherited from the parent DB

    Returns undefined | ReadPreference

writeConcern

  • The current writeConcern of the collection. If not explicitly defined for this collection, will be inherited from the parent DB

    Returns undefined | WriteConcern

Methods

aggregate

bulkWrite

  • Perform a bulkWrite operation without a fluent API

    Legal operation types are

    • insertOne
    • replaceOne
    • updateOne
    • updateMany
    • deleteOne
    • deleteMany

    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.

    throws

    MongoDriverError if operations is not an array

    Parameters

    Returns Promise<BulkWriteResult>

count

  • 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

    Parameters

    • filter: Filter<TSchema> = {}

      The filter for the count.

    • options: CountOptions = {}

      Optional settings for the command

    Returns Promise<number>

countDocuments

createIndex

  • Creates an index on the db and collection collection.

    example
    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' }])

    Parameters

    Returns Promise<string>

createIndexes

  • 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 here.

    example
    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'
      }
    ]);

    Parameters

    Returns Promise<string[]>

deleteMany

deleteOne

distinct

drop

  • Drop the collection from the database, removing it permanently. New accesses will create a new collection.

    Parameters

    Returns Promise<boolean>

dropIndex

dropIndexes

estimatedDocumentCount

  • 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

    Count: Behavior

    Parameters

    Returns Promise<number>

find

findOne

findOneAndDelete

  • Find a document and delete it in one atomic operation. Requires a write lock for the duration of the operation.

    Parameters

    • filter: Filter<TSchema>

      The filter used to select the document to remove

    • Optional options: FindOneAndDeleteOptions

      Optional settings for the command

    Returns Promise<ModifyResult<TSchema>>

findOneAndReplace

  • Find a document and replace it in one atomic operation. Requires a write lock for the duration of the operation.

    Parameters

    • filter: Filter<TSchema>

      The filter used to select the document to replace

    • replacement: WithoutId<TSchema>

      The Document that replaces the matching document

    • Optional options: FindOneAndReplaceOptions

      Optional settings for the command

    Returns Promise<ModifyResult<TSchema>>

findOneAndUpdate

  • Find a document and update it in one atomic operation. Requires a write lock for the duration of the operation.

    Parameters

    • filter: Filter<TSchema>

      The filter used to select the document to update

    • update: UpdateFilter<TSchema>

      Update operations to be performed on the document

    • Optional options: FindOneAndUpdateOptions

      Optional settings for the command

    Returns Promise<ModifyResult<TSchema>>

indexExists

  • Checks if one or more indexes exist on the collection, fails on first non-existing index

    Parameters

    • indexes: string | string[]

      One or more index names to check.

    • Optional options: IndexInformationOptions

      Optional settings for the command

    Returns Promise<boolean>

indexInformation

indexes

initializeOrderedBulkOp

  • 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 implementation. However, collection.bulkWrite() provides an equivalent API that does not require prior connecting.

    Parameters

    Returns OrderedBulkOperation

initializeUnorderedBulkOp

  • 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 implementation. However, collection.bulkWrite() provides an equivalent API that does not require prior connecting.

    Parameters

    Returns UnorderedBulkOperation

insertMany

  • 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.

    Parameters

    Returns Promise<InsertManyResult<TSchema>>

insertOne

  • 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.

    Parameters

    Returns Promise<InsertOneResult<TSchema>>

isCapped

  • Returns if the collection is a capped collection

    Parameters

    Returns Promise<boolean>

listIndexes

options

rename

  • Rename the collection.

    remarks

    This operation does not inherit options from the Db or MongoClient.

    Parameters

    • newName: string

      New name of of the collection.

    • Optional options: RenameOptions

      Optional settings for the command

    Returns Promise<Collection<Document>>

replaceOne

  • Replace a document in a collection with another document

    Parameters

    • filter: Filter<TSchema>

      The filter used to select the document to replace

    • replacement: WithoutId<TSchema>

      The Document that replaces the matching document

    • Optional options: ReplaceOptions

      Optional settings for the command

    Returns Promise<Document | UpdateResult<TSchema>>

stats

  • Get all the collection statistics.

    deprecated

    the collStats operation will be removed in the next major release. Please use an aggregation pipeline with the $collStats stage instead

    Parameters

    Returns Promise<CollStats>

updateMany

  • Update multiple documents in a collection

    Parameters

    • filter: Filter<TSchema>

      The filter used to select the documents to update

    • update: UpdateFilter<TSchema>

      The update operations to be applied to the documents

    • Optional options: UpdateOptions

      Optional settings for the command

    Returns Promise<UpdateResult<TSchema>>

updateOne

  • Update a single document in a collection

    Parameters

    • filter: Filter<TSchema>

      The filter used to select the document to update

    • update: UpdateFilter<TSchema> | Partial<TSchema>

      The update operations to be applied to the document

    • Optional options: UpdateOptions

      Optional settings for the command

    Returns Promise<UpdateResult<TSchema>>

watch

  • 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 use cases:

    • 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 }>

    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!

    collection
      .watch<Schema, ChangeStreamInsertDocument<Schema> & { 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<Schema>(change.fullDocument);
      });

    Type parameters

    Parameters

    Returns ChangeStream<TLocal, TChange>

Generated using TypeDoc