Class Collection<TSchema>

The name of this collection此集合的名称

The name of the database this collection belongs to此集合所属数据库的名称

The current index hint for the collection集合的当前索引提示

The namespace of this collection, in the format ${this.dbName}.${this.collectionName}集合的命名空间，格式为${this.dbName}.${this.collectionName}。

The current readConcern of the collection. 集合的当前readConcern。If not explicitly defined for this collection, will be inherited from the parent DB如果没有为此集合明确定义，则将从父数据库继承

The current readPreference of the collection. If not explicitly defined for this collection, will be inherited from the parent DB集合的当前readPreference。如果没有为此集合明确定义，则将从父数据库继承

The current writeConcern of the collection. 集合的当前writeConcern。If not explicitly defined for this collection, will be inherited from the parent DB如果没有为此集合明确定义，则将从父数据库继承

Execute an aggregation framework pipeline against the collection, needs MongoDB >= 2.2针对集合执行聚合框架管道，需要MongoDB>=2.2

Perform a bulkWrite operation without a fluent API在没有fluent API的情况下执行bulkWrite操作

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. 如果传入的文档不包含_id字段，则驱动程序将向缺少该字段的每个文档添加一个字段，从而使文档发生变化。This behavior can be overridden by setting the forceServerObjectId flag.可以通过设置forceServerObjectId标志来覆盖此行为。

Throws

MongoDriverError if operations is not an arrayMongoDriverError如果操作不是数组

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 countDocuments.此方法已被弃用，因为它无法提供集合中文档的准确计数。若要获得集合中文档的准确计数，请使用countDocuments。 To obtain an estimated count of all documents in the collection, use estimatedDocumentCount.若要获取集合中所有文档的估计计数，请使用estimatedDocumentCount。

Deprecated

use countDocuments or estimatedDocumentCount instead请改用countDocuments或estimatedDocumentCount。

Gets the number of documents matching the filter. 获取与筛选器匹配的文档数。For a fast count of the total documents in a collection see estimatedDocumentCount. 有关集合中文档总数的快速计数，请参阅estimatedDocumentCount。Note: When migrating from count to countDocuments the following query operators must be replaced:：从count迁移到countDocuments时，必须替换以下查询运算符：

See

• /v7.0/reference/operator/query/expr/
• /v7.0/reference/operator/query/geoWithin/
• /v7.0/reference/operator/query/center/#op._S_center
• /v7.0/reference/operator/query/centerSphere/#op._S_centerSphere

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

Creates multiple indexes in the collection, this method is only supported for MongoDB 2.6 or higher. 在集合中创建多个索引，此方法仅适用于MongoDB 2.6或更高版本。Earlier version of MongoDB will throw a command not supported error.早期版本的MongoDB将抛出一个不支持的命令错误。

Note: Unlike createIndex, this function takes in raw index specifications.：与createIndex不同，此函数接受原始索引规范。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'
  }
]);
Copy

Creates a single search index for the collection.为集合创建单个搜索索引。

Remarks

Only available when used against a 7.0+ Atlas cluster.仅在针对7.0以上Atlas群集使用时可用。

Creates multiple search indexes for the current collection.为当前集合创建多个搜索索引。

Remarks

Only available when used against a 7.0+ Atlas cluster.仅在针对7.0以上Atlas群集使用时可用。

Delete multiple documents from a collection从集合中删除多个文档

Delete a document from a collection从集合中删除文档

The distinct command returns a list of distinct values for the given key across a collection.distinct命令返回集合中给定键的不同值列表。

Drop the collection from the database, removing it permanently. New accesses will create a new collection.从数据库中删除集合，并将其永久删除。新的访问将创建一个新的集合。

Drops an index from this collection.从此集合中删除索引。

Drops all indexes from this collection.从此集合中删除所有索引。

Deletes a search index by index name.按索引名称删除搜索索引。

Remarks

Only available when used against a 7.0+ Atlas cluster.仅在针对7.0以上Atlas群集使用时可用。

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.这将始终在所有服务器版本上运行count命令。

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.由于MongoDB 5.0.0-5.0.8版本中的一个疏忽，estimatedDocumentCount在其实现中使用的count命令未包含在Stable API的v1中，因此建议使用estimatedDocumentCount的Stable API用户将其服务器版本升级到5.0.9+或设置apiStrict：false以避免出现错误。

See

Behavior

Creates a cursor for a filter that can be used to iterate over results from MongoDB为筛选器创建一个游标，该筛选器可用于迭代MongoDB的结果

Fetches the first document that matches the filter获取与筛选器匹配的第一个文档

Find a document and delete it in one atomic operation. Requires a write lock for the duration of the operation.在一个原子操作中查找文档并将其删除。在操作期间需要写锁定。

Find a document and replace it in one atomic operation. Requires a write lock for the duration of the operation.查找文档并在一个原子操作中替换它。在操作期间需要写锁定。

Find a document and update it in one atomic operation. Requires a write lock for the duration of the operation.查找文档并在一个原子操作中更新它。在操作期间需要写锁定。

Checks if one or more indexes exist on the collection, fails on first non-existing index检查集合中是否存在一个或多个索引，在第一个不存在的索引上失败

Retrieves this collections index info.检索此集合的索引信息。

Retrieve all the indexes on the collection.检索集合上的所有索引。

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.由于此遗留实现中的已知限制，在调用此方法之前必须连接MongoClient。 However, collection.bulkWrite() provides an equivalent API that does not require prior connecting.但是，collection.bulkWrite()提供了一个等效的API，不需要预先连接。

Initiate an Out of order batch write operation. All operations will be buffered into insert/update/remove commands executed out of order.启动无序批量写入操作。所有操作都将被缓冲到无序执行的insert/update/remove命令中。

Throws

MongoNotConnectedError

Remarks

NOTE: MongoClient must be connected prior to calling this method due to a known limitation in this legacy implementation.由于此遗留实现中的已知限制，在调用此方法之前必须连接MongoClient。 However, collection.bulkWrite() provides an equivalent API that does not require prior connecting.但是，collection.bulkWrite()提供了一个等效的API，不需要预先连接。

Inserts an array of documents into MongoDB. 在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. 如果传入的文档不包含_id字段，则驱动程序将向缺少该字段的每个文档添加一个字段，从而使文档发生变化。This behavior can be overridden by setting the forceServerObjectId flag.可以通过设置forceServerObjectId标志来覆盖此行为。

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.在MongoDB中插入一个文档。如果传入的文档不包含_id字段，则驱动程序将向缺少该字段的每个文档添加一个字段，从而使文档发生变化。可以通过设置forceServerObjectId标志来覆盖此行为。

Returns if the collection is a capped collection如果集合是封顶集合，则返回true

Get the list of all indexes information for the collection.获取集合的所有索引信息的列表。

Returns all search indexes for the current collection.返回当前集合的所有搜索索引。

Remarks

Only available when used against a 7.0+ Atlas cluster.仅在针对7.0以上Atlas群集使用时可用。

Returns all search indexes for the current collection.返回当前集合的所有搜索索引。

Remarks

Only available when used against a 7.0+ Atlas cluster.仅在针对7.0以上Atlas群集使用时可用。

Returns the options of the collection.返回集合的选项。

Rename the collection.重命名集合。

Remarks

This operation does not inherit options from the Db or MongoClient.此操作不会从Db或MongoClient继承选项。

Replace a document in a collection with another document用另一个文档替换集合中的文档

Update multiple documents in a collection更新集合中的多个文档

Update a single document in a collection更新集合中的单个文档

Updates a search index by replacing the existing index definition with the provided definition.通过用提供的定义替换现有索引定义来更新搜索索引。

Remarks

Only available when used against a 7.0+ Atlas cluster.仅在针对7.0以上Atlas群集使用时可用。

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:watch()为不同的用例接受两个泛型参数：

• 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第二种是完全覆盖变更流文档的形状，如果没有提供，则类型将默认为第一个参数的ChangeStreamDocument

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)));
Copy

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.在这里，我们使用了一个管道，让MongoDB筛选器只用于插入更改并添加注释。No need start from scratch on the ChangeStreamInsertDocument type!ChangeStreamInsertDocument类型无需从头开始！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);
  });
Copy