MongoDB\Collection::estimatedDocumentCount()

Definición

MongoDB\Collection::estimatedDocumentCount()

Se obtiene un número estimado de documentos en la colección mediante el uso de metadatos de la colección.

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

Parámetros

$options : arreglo

Un arreglo que especifica las opciones deseadas.

Nombre	Tipo	Descripción
comment	mixto	Permite a los usuarios especificar un comentario arbitrario para ayudar a rastrear la operación a través de perfilador de base de datos, output de currentOp y registros. Esta opción está disponible desde MongoDB 4.4 y, si se especifica para una versión de servidor anterior, dará lugar a una excepción en tiempo de ejecución. Novedades en la versión 1.13.
maxTimeMS	entero	El límite de tiempo acumulado en milisegundos para las operaciones de procesamiento en el cursor. MongoDB aborta la operación en el siguiente punto de interrupción..
readConcern	MongoDB\Driver\ReadConcern	Nivel de consistencia de lectura para usar en la operación. Por defecto, adopta el nivel de consistencia de lectura de la colección. No es posible especificar un nivel de consistencia de lectura para operaciones individuales como parte de una transacción. En su lugar, configura la opción readConcern al iniciar la transacción.
readPreference	MongoDB\Driver\ReadPreference	Preferencia de lectura a utilizar para la operación. Por defecto, se utiliza la preferencia de lectura de la colección.
sesión	MongoDB\Driver\Session	Sesión de cliente para asociar con la operación.

Return Values

Una estimación del número de documentos en la colección.

Errores/Excepciones

MongoDB\Exception\UnexpectedValueException si la respuesta del comando del servidor era incorrecta.

MongoDB\Exception\UnsupportedException si se usan opciones que no sean compatibles con el servidor seleccionado (p. ej. collation, readConcern, writeConcern).

MongoDB\Exception\InvalidArgumentException por errores relacionados con el análisis de parámetros u opciones.

MongoDB\Driver\Exception\RuntimeException para otros errores a nivel de extensión (por ejemplo, " errores de conexión).

Comportamiento

Este método devuelve una estimación del número de documentos en la colección utilizando metadatos de la colección, en lugar de contar los documentos o consultar un índice. Este método no utiliza la opción session y no puede ejecutarse dentro de una transacción. Consulta Count: Behavior en el Manual de MongoDB para obtener más información.

Este método se implementa usando el comando contar. El comando count no está incluido en la versión "1" de la API Stable. Si estás utilizando este método con la Stable API, te recomendamos actualizar la versión de tu servidor a 5.0.9+ o desactivar el modo estricto para evitar posibles errores.

Ver también

• Referencia del comando count en el manual de MongoDB

• MongoDB\Collection::countDocuments()