MongoDB\Collection::estimatedDocumentCount()

定义

MongoDB\Collection::estimatedDocumentCount()

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

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

参数

$options : 数组

指定所需选项的数组。

名称	类型	描述
注释	混合型	允许用户指定任意注释，以帮助通过数据库分析器、当前操作输出和日志来追踪操作。数据库分析器，当前操作输出，和日志。 此选项从 MongoDB 4.4 版本开始可用，如果为旧版本服务器指定，则在执行时会引发异常。 新增在版本中1.13.
maxTimeMS	整数	游标上处理操作的累积时间限制（毫秒）。MongoDB 在下一个中断点处终止操作。
readConcern	MongoDB\Driver\ReadConcern	为操作使用读取关注点。默认为集合的读取关注点。 无法在事务的一部分中为单个操作指定读取关注点。相反，在开始事务
readPreference	MongoDB\Driver\ReadPreference	为操作使用读取偏好。默认为集合的读取偏好。
session	MongoDB\Driver\Session	与操作关联的客户端会话。

返回值

集合中估计的文档数量。

错误/异常

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

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

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

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

行为

此方法使用集合元数据来估算集合中文档的数量，而不是计数文档或查询索引。此方法不接受session选项，且不能在事务中执行。有关更多信息，请参阅MongoDB手册中的计数：行为。

此方法使用count命令实现。由于MongoDB 5.0.0-5.0.8版本中的疏忽，count命令未包含在稳定API的版本"1"中。建议使用此方法的稳定API的应用程序升级其服务器版本到5.0.9+或禁用严格模式以避免遇到错误。

另请参阅

• MongoDB手册中的count命令参考

• MongoDB\Collection::countDocuments()