MongoDB\Collection::count()

定义

MongoDB\Collection::count()

计算符合筛选条件的文档数量。

function count(
    array|object $filter = [],
    array $options = []
): integer

参数

$filter : array|object

指定要计数的文档的筛选条件。

$options : array

指定所需选项的数组。

名称	类型	说明
排序规则	数组|对象	排序规则允许用户为字符串比较指定特定于语言的规则，例如字母大小写和重音符号规则。指定排序规则时，locale 字段为必填字段；所有其他排序规则字段都是可选的。有关字段的说明，请参阅排序规则文档。 如果未指定排序规则但集合具有默认排序规则，则操作将使用为集合指定的排序规则。如果没有为集合或操作指定排序规则，MongoDB 将使用先前版本中用于字符串比较的简单二进制比较。
comment	混合	使用户可以指定任意注释来帮助通过数据库分析器、currentOp 输出和日志来跟踪操作。 自 MongoDB 4.4 起此选项可用，如果为旧服务器版本指定，则会在执行时导致异常。 1.13版本新增。
提示	字符串|数组|对象	要使用的索引。将索引名称指定为字符串或将索引键模式指定为文档。如果指定，查询系统将只考虑使用提示索引的计划。 在版本 1.2 中进行了更改： 如果提供文档，则将其原样传递给命令。以前，该库会将密钥模式转换为索引名。
limit	整型	要返回的匹配文档的最大数量。
maxTimeMS	整型	在游标上处理操作的累计时间限制（以毫秒为单位）。MongoDB 最早会在中断点之后中止操作。
事务外的	MongoDB\Driver\ReadConcern	用于操作的读关注。默认为该集合的读关注。 不能将单个操作的读关注指定为事务的一部分，而应在启动事务时设置 readConcern 选项。
readPreference	MongoDB\Driver\ReadPreference	用于操作的读取偏好。默认为该集合的读取偏好。
会话	MongoDB\Driver\Session	与操作相关联的客户端会话。 1.3版本新增。
跳过	整型	返回结果之前要跳过的匹配文档数。

Return Values

与筛选条件匹配的文档数量。

错误/异常

MongoDB\Exception\UnexpectedValueException ，如果来自服务器的命令响应格式错误。

MongoDB\Exception\UnsupportedException，如果所选服务器使用了选项但不支持选项（例如collation、readConcern、writeConcern）。

MongoDB\Exception\InvalidArgumentException 用于与参数或选项解析相关的错误。

MongoDB\ 驱动程序\Exception\RuntimeException 用于扩展级别的其他错误（例如连接错误）。

行为

此方法已弃用，并且无法在ACID 事务中执行。它一直是使用计数命令来实现的。 count命令的行为因传递给它的选项而异，并且可能会也可能不会提供准确的计数。如果未提供查询过滤， 命令将使用集合元数据提供估计值。即使提供了查询过滤，如果存在孤立文档或正在进行数据块迁移， 命令也可能会返回不准确的分片集群结果。count countMongoDB\Collection::countDocuments()方法完全避免了这些分片集群问题。

在评估查询条件时， MongoDB会根据自己的BSON 类型比较规则来比较类型和值，这与 PHP 的比较和类型规则不同。匹配特殊BSON类型时，查询条件应使用扩展中相应的BSON类（例如使用MongoDB\BSON\ObjectId来匹配ObjectId）。

另请参阅

• MongoDB 手册中的count命令参考

• MongoDB\Collection::countDocuments()

• MongoDB\Collection::estimatedDocumentCount()