MongoDB\collection::count()

本页内容

定义

参数
返回值
错误/异常
行为
另请参阅

已弃用自版本1.4.

定义

MongoDB\collection::count()

计算符合过滤器条件的文档数量。

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

参数

$filter : array|object

指定要计数的文档的过滤器条件。

$options : array

指定所需选项的数组。

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

返回值

符合过滤器条件的文档数量。

错误/异常

MongoDB\Exception\UnexpectedValueException 如果服务器命令响应格式不正确。

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

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

MongoDB\Driver\Exception\RuntimeException用于扩展级别其他错误（例如连接错误）。

行为

此方法已弃用，无法在事务中执行。它始终使用count命令来实现。count命令的行为取决于传递给它的选项，可能或可能不提供准确的计数。当未提供查询过滤器时，count命令使用集合元数据提供估计。即使提供了查询过滤器，count命令在存在孤立文档或正在进行数据分片迁移的碎片化集群中也可能返回不准确的结果。MongoDB\Collection::countDocuments()方法可以完全避免这些问题。

When evaluating query criteria, MongoDB compares types and values according to its own comparison rules for BSON types, which differs from PHP's comparison and type juggling rules. When matching a special BSON type the query criteria should use the respective BSON class in the extension (e.g. use MongoDB\BSON\ObjectId to match an ObjectId).

另请参阅

count 命令参考，见 MongoDB 手册
MongoDB\Collection::countDocuments()
MongoDB\Collection::estimatedDocumentCount()

bulkWrite()

countDocuments()