MongoDB\Collection::estimatedDocumentCount()

定义

MongoDB\Collection::estimatedDocumentCount()

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

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

参数

$options : array

指定所需选项的数组。

名称	类型	说明
comment	混合	允许用户指定任意注释，以帮助通过数据库分析器、 currentOp输出和日志跟踪操作。 要使用此选项，您必须连接到MongoDB 6.0 或更高版本。如果您连接到早期版本，服务器将在执行时返回异常。 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命令来实现的。count 命令未包含在 1 版本的 Stable API中。如果启用Stable API并希望使用此方法，请将服务器版本升级到MongoDB 6.0 或禁用严格模式，以避免出现错误。

另请参阅

• MongoDB 手册中的count命令参考

• MongoDB\Collection::countDocuments()