cursor.count()

On this page本页内容

Definition定义

cursor.count()
Important重要
mongosh Method

This is a mongosh method. 这是mongosh方法。This is not the documentation for Node.js or other programming language specific driver methods.

In most cases, mongosh methods work the same way as the legacy mongo shell methods. However, some legacy methods are unavailable in mongosh.

For the legacy mongo shell documentation, refer to the documentation for the corresponding MongoDB Server release:

For MongoDB API drivers, refer to the language specific MongoDB driver documentation.

Note注意

MongoDB drivers compatible with the 4.0 features deprecate their respective cursor and collection count() APIs in favor of new APIs that corresponds to countDocuments() and estimatedDocumentCount(). 与4.0功能兼容的MongoDB驱动程序不推荐各自的游标和集合count()API,而支持与countDocuments()estimatedDocumentCount()相对应的新API。For the specific API names for a given driver, see the driver API documentation.有关给定驱动程序的特定API名称,请参阅驱动程序API文档。

Counts the number of documents referenced by a cursor. 统计游标引用的文档数。Append the count() method to a find() query to return the number of matching documents. count()方法附加到find()查询,以返回匹配文档的数量。The operation does not perform the query but instead counts the results that would be returned by the query.该操作不执行查询,而是统计查询将返回的结果。

Important重要
  • Avoid using count() if the find() operation is run without a query predicate since without the query predicate, these count() returns results based on the collection's metadata, which may result in an approximate count. 如果find()操作在没有查询谓词的情况下运行,请避免使用count(),因为如果没有查询谓语,这些count()返回基于集合元数据的结果,它可能产生大约数。In particular,特别地,

    • On a sharded cluster, the resulting count will not correctly filter out orphaned documents.在分片集群上,结果计数将无法正确筛选出孤立文档
    • After an unclean shutdown, the count may be incorrect.不干净停机后,计数可能不正确。
  • For counts based on collection metadata, see also collStats pipeline stage with the count option.有关基于集合元数据的计数,请参阅带有计数选项的collStats管道阶段

The count() method has the following prototype form:count()方法具有以下原型形式:

db.collection.find(<query>).count()

The count() method has the following parameter:count()方法具有以下参数:

Parameter参数Type类型Description描述
applySkipLimitbooleanOptional. 可选。Specifies whether to consider the effects of the cursor.skip() and cursor.limit() methods in the count. 指定是否在计数中考虑cursor.skip()cursor.limit()方法的影响。By default, the count() method ignores the effects of the cursor.skip() and cursor.limit(). 默认情况下,count()方法忽略cursor.skip()cursor.limit()的效果。Set applySkipLimit to true to consider the effect of these methods.applySkipLimit设置为true以考虑这些方法的效果。

MongoDB also provides an equivalent db.collection.count() as an alternative to the db.collection.find(<query>).count() construct.MongoDB还提供了一个等效的db.collection.count(),作为db.collection.find(<query>).count()构造的替代方法。

MongoDB supports the use of hint() with count(). MongoDB支持使用hint()count()See Specify the Index to Use for an example.有关示例,请参阅指定要使用的索引

Tip提示
See also: 参阅:

Behavior行为

Count and Transactions计数和事务处理

You cannot use count and shell helpers count() and db.collection.count() in transactions.不能在事务中使用count和shell助手count()db.collection.count())。

For details, see Transactions and Count Operations.有关详细信息,请参阅事务和计数操作

Sharded Clusters分片群集

On a sharded cluster, count() without a query predicate in the find can result in an inaccurate count if orphaned documents exist or if a chunk migration is in progress.在分片集群上,如果存在孤立文档或正在进行区块迁移,则find中没有查询谓词的count()可能会导致计数不准确

To avoid these situations, on a sharded cluster, use the db.collection.aggregate() method:要避免这些情况,请在分片集群上使用db.collection.aggregate()方法:

You can use the $count stage to count the documents. 您可以使用$count阶段对文档进行计数。For example, the following operation counts the documents in a collection:例如,以下操作对集合中的文档进行计数:

db.collection.aggregate( [
   { $count: "myCount" }
])

The $count stage is equivalent to the following $group + $project sequence:$count阶段相当于以下$group+$project序列:

db.collection.aggregate( [
   { $group: { _id: null, count: { $sum: 1 } } }
   { $project: { _id: 0 } }
] )
Tip提示
See also: 参阅:

$collStats to return an approximate count based on the collection's metadata.根据集合的元数据返回近似计数。

Index Use索引使用

Consider a collection with the following index:考虑具有以下索引的集合:

{ a: 1, b: 1 }

When performing a count, MongoDB can return the count using only the index if:在执行计数时,如果满足以下条件,MongoDB只能使用索引返回计数:

  • the query can use an index,查询可以使用索引,
  • the query only contains conditions on the keys of the index, and查询只包含索引键上的条件,并且
  • the query predicates access a single contiguous range of index keys.查询谓词访问单个连续的索引键范围。

For example, the following operations can return the count using only the index:例如,以下操作只能使用索引返回计数:

db.collection.find( { a: 5, b: 5 } ).count()
db.collection.find( { a: { $gt: 5 } } ).count()
db.collection.find( { a: 5, b: { $gt: 10 } } ).count()

If, however, the query can use an index but the query predicates do not access a single contiguous range of index keys or the query also contains conditions on fields outside the index, then in addition to using the index, MongoDB must also read the documents to return the count.但是,如果查询可以使用索引,但查询谓词不访问单个连续的索引键范围,或者查询还包含索引外字段的条件,那么除了使用索引外,MongoDB还必须读取文档以返回计数。

db.collection.find( { a: 5, b: { $in: [ 1, 2, 3 ] } } ).count()
db.collection.find( { a: { $gt: 5 }, b: 5 } ).count()
db.collection.find( { a: 5, b: 5, c: 5 } ).count()

In such cases, during the initial read of the documents, MongoDB pages the documents into memory such that subsequent calls of the same count operation will have better performance.在这种情况下,在文档的初始读取期间,MongoDB将文档分页到内存中,这样相同计数操作的后续调用将具有更好的性能。

Examples示例

The following are examples of the count() method.以下是count()方法的示例。

Count All Documents统计所有文档

The following operation counts the number of all documents in the orders collection:以下操作统计orders集合中所有文档的数量:

db.orders.find().count()

Count Documents That Match a Query统计与查询匹配的文档

The following operation counts the number of the documents in the orders collection with the field ord_dt greater than new Date('01/01/2012'):以下操作统计orders集合中字段ord_dt大于new Date('01/01/2012')的文档数:

db.orders.find( { ord_dt: { $gt: new Date('01/01/2012') } } ).count()

Limit Documents in Count限制文档计数

The following operation counts the number of the documents in the orders collection with the field ord_dt greater than new Date('01/01/2012') taking into account the effect of the limit(5):以下操作计算orders集合中字段ord_dt大于new Date('01/01/2012')的文档数,并考虑limit(5)的影响:

db.orders.find( { ord_dt: { $gt: new Date('01/01/2012') } } ).limit(5).count(true)

Specify the Index to Use指定要使用的索引

The following operation uses the index named "status_1", which has the index key specification of { status: 1 }, to return a count of the documents in the orders collection with the field ord_dt greater than new Date('01/01/2012') and the status field is equal to "D":以下操作使用名为"status_1"的索引(其索引键规范为{status:1})返回订单集合中文档的计数,其中字段ord_dt大于new Date('01/01/2012')status字段等于"D"

db.orders.find(
   { ord_dt: { $gt: new Date('01/01/2012') }, status: "D" }
).hint( "status_1" ).count()
←  cursor.comment()cursor.explain() →