MongoDB\Collection::estimatedDocumentCount()

定义

MongoDB\Collection::estimatedDocumentCount()

使用集合元数据获取集合中的估计文档数。

function countDocuments(array $options = []): integer

参数

$options : array

指定所需选项的数组。

名称	类型	说明
comment	混合	使用户可以指定任意注释来帮助通过数据库分析器、currentOp 输出和日志来跟踪操作。 自 MongoDB 4.4 起此选项可用，如果为旧服务器版本指定，则会在执行时导致异常。 1.13版本新增。
maxTimeMS	整型	在游标上处理操作的累计时间限制（以毫秒为单位）。MongoDB 最早会在中断点之后中止操作。
事务外的	MongoDB\Driver\ReadConcern	用于操作的读关注。默认为该集合的读关注。 不能将单个操作的读关注指定为事务的一部分，而应在启动事务时设置 readConcern 选项。
readPreference	MongoDB\Driver\ReadPreference	用于操作的读取偏好。默认为该集合的读取偏好。
会话	MongoDB\Driver\Session	与操作相关联的客户端会话。

Return Values

集合中文档的估计数量。

错误/异常

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

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

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

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

行为

此方法使用集合元数据返回集合中文档计数的估计值，而不是对文档进行计数或咨询索引。 此方法不带session选项，因此无法在ACID 事务中执行。 有关更多信息，请参阅MongoDB手册中的计数：行为。

此方法是使用 count count1命令来实现的。版本“”中不包含 命令Stable API的 。如果您将此方法与 Stable API一起使用，我们建议您将服务器版本升级到..5 09+ 或禁用严格模式以避免出现错误。

另请参阅

• MongoDB 手册中的count命令参考

• MongoDB\Collection::countDocuments()