Database Manual / Reference / mongosh Methods

Collection Methods集合方法

Note

mongosh Methods方法

The methods listed on this table of contents page are mongosh methods. This is not the documentation for Node.js or other programming language specific driver methods.此目录页上列出的方法是mongosh方法。这不是Node.js或其他特定于编程语言的驱动程序方法的文档。

In most cases, mongosh methods work the same way as the legacy mongo shell methods. However, some legacy methods are unavailable in mongosh.在大多数情况下，mongosh方法的工作方式与遗留的mongoshell方法相同。然而，一些遗留方法在mongosh中不可用。

For MongoDB API drivers, refer to the language specific MongoDB driver documentation.有关MongoDB API驱动程序，请参阅特定语言的MongoDB驱动程序文档。

Note

For details on a specific method, including syntax and examples, click on the link to the method's reference page.有关特定方法的详细信息，包括语法和示例，请单击该方法参考页面的链接。

Name名称Description描述
db.collection.analyzeShardKey()Calculates metrics for evaluating a shard key.计算用于评估分片键的指标。
db.collection.aggregate()Provides access to the aggregation pipeline. You can also also use this method on a view.提供对聚合管道的访问。您还可以在视图上使用此方法。
db.collection.bulkWrite()Provides bulk write operation functionality.提供批量写入操作功能。
db.collection.configureQueryAnalyzer()Configures query sampling for a collection.为集合配置查询采样。
db.collection.count()Wraps count to return a count of the number of documents in a collection or a view.包装count返回集合或视图中文档数量的计数。
db.collection.countDocuments()Wraps the $group aggregation stage with a $sum expression to return a count of the number of documents in a collection or a view.用$sum表达式包装$group聚合阶段，以返回集合或视图中文档数量的计数。
db.collection.createIndex()Builds an index on a collection.在集合上构建索引。
db.collection.createIndexes()Builds one or more indexes on a collection.在集合上构建一个或多个索引。
db.collection.dataSize()Returns the size of the collection. Wraps the size field in the output of the collStats.返回集合的size。将大小字段包裹在collStats的输出中。
db.collection.deleteOne()Deletes a single document in a collection.删除集合中的单个文档。
db.collection.deleteMany()Deletes multiple documents in a collection.删除集合中的多个文档。
db.collection.distinct()Returns an array of documents that have distinct values for the specified field.返回指定字段具有不同值的文档数组。
db.collection.drop()Removes the specified collection from the database.从数据库中删除指定的集合。
db.collection.dropIndex()Removes a specified index on a collection.删除集合上的指定索引。
db.collection.dropIndexes()Removes all indexes on a collection.删除集合上的所有索引。
db.collection.estimatedDocumentCount()Wraps count to return an approximate count of the documents in a collection or a view.包装count返回集合或视图中文档的近似计数。
db.collection.explain()Returns information on the query execution of various methods.返回各种方法的查询执行信息。
db.collection.find()Performs a query on a collection or a view and returns a cursor object.对集合或视图执行查询并返回游标对象。
db.collection.findAndModify()Atomically modifies and returns a single document.原子化修改并返回单个文档。
db.collection.findOne()Performs a query and returns a single document.执行查询并返回单个文档。
db.collection.findOneAndDelete()Finds a single document and deletes it.查找单个文档并将其删除。
db.collection.findOneAndReplace()Finds a single document and replaces it.查找单个文档并替换它。
db.collection.findOneAndUpdate()Finds a single document and updates it.查找单个文档并更新它。
db.collection.getIndexes()Returns an array of documents that describe the existing indexes on a collection.返回描述集合上现有索引的文档数组。
db.collection.getShardDistribution()For collections in sharded clusters, db.collection.getShardDistribution() reports data of chunk distribution.对于分片集群中的集合，db.collection.getShardDistribution()报告块分布的数据。
db.collection.getShardVersion()Internal diagnostic method for sharded cluster.分片群集的内部诊断方法。
db.collection.hideIndex()Hides an index from the query planner.在查询计划器中隐藏索引。
db.collection.insertOne()Inserts a new document in a collection.在集合中插入新文档。
db.collection.insertMany()Inserts several new document in a collection.在集合中插入多个新文档。
db.collection.isCapped()Reports if a collection is a capped collection.报告集合是否为封顶集合。
db.collection.latencyStats()Returns latency statistics for a collection.返回集合的延迟统计信息。
db.collection.mapReduce()Performs map-reduce style data aggregation.执行映射缩减样式数据聚合。
db.collection.reIndex()Rebuilds all existing indexes on a collection.重建集合上的所有现有索引。
db.collection.remove()Deletes documents from a collection.从集合中删除文档。
db.collection.renameCollection()Changes the name of a collection.更改集合的名称。
db.collection.replaceOne()Replaces a single document in a collection.替换集合中的单个文档。
db.collection.stats()Reports on the state of a collection. Provides a wrapper around the collStats.关于集合状态的报告。为collStats提供包装。
db.collection.storageSize()Reports the total size used by the collection in bytes. Provides a wrapper around the storageSize field of the collStats output.报告集合使用的总大小（以字节为单位）。为collStats输出的storageSize字段提供包装。
db.collection.totalIndexSize()Reports the total size used by the indexes on a collection. 报告集合上索引使用的总大小。Provides a wrapper around the totalIndexSize field of the collStats output.为collStats输出的totalIndexSize字段提供包装。
db.collection.totalSize()Reports the total size of a collection, including the size of all documents and all indexes on a collection.报告集合的总大小，包括集合上所有文档和所有索引的大小。
db.collection.unhideIndex()Unhides an index from the query planner.从查询计划器中取消隐藏索引。
db.collection.updateOne()Modifies a single document in a collection.修改集合中的单个文档。
db.collection.updateMany()Modifies multiple documents in a collection.修改集合中的多个文档。
db.collection.watch()Establishes a Change Stream on a collection.在集合上建立更改流。
db.collection.validate()Performs diagnostic operations on a collection.对集合执行诊断操作。

Tip

To manage MongoDB Search indexes, see MongoDB Search and Vector Search Index Methods.要管理MongoDB搜索索引，请参阅MongoDB搜索和向量搜索索引方法。