MongoDB\Collection::estimatedDocumentCount()

Definición

MongoDB\Collection::estimatedDocumentCount()

Obtiene un número estimado de documentos en la colección utilizando metadatos de la colección.

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

Parámetros

$options : matriz

Una matriz 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 del generador de perfilesde base de datos, salidacurrentOpy registros. Esta opción está disponible desde MongoDB 4.4 y generará una excepción en el momento de ejecución si se especifica para una versión de servidor anterior. Novedades en la versión 1.13.
maxTimeMS	entero	El límite de tiempo acumulado en milisegundos para procesar operaciones en el cursor. MongoDB cancela la operación en el punto de interrupción posterior más cercano.
readConcern	MongoDB\Driver\ReadConcern	Preocupación de lectura para la operación. El valor predeterminado es la preocupación de lectura de la colección. No es posible especificar una preocupación de lectura para operaciones individuales como parte de una transacción. En su lugar, configure la readConcern opción al iniciar la transacción.
readPreference	MongoDB\Controlador\Preferencia de lectura	Preferencia de lectura para la operación. El valor predeterminado es la preferencia de lectura de la colección.
sesión	MongoDB\Controlador\Sesión	Sesión de cliente para asociar a la operación.

Return Values

Número estimado 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 utilizan opciones que no son compatibles con el servidor seleccionado (porcollation readConcernwriteConcernejemplo,,,).

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

MongoDB\Driver\Exception\RuntimeException para otros errores en el 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 los metadatos de la colección, en lugar de contar los documentos o consultar un índice. Este método no acepta la session opción y no se puede ejecutar dentro de una transacción.Consulte "Conteo: Comportamiento" en el manual de MongoDB para obtener más información.

Este método se implementa mediante el comando count. El count comando no está incluido en la versión "1" de la API estable. Si utiliza este método con la API estable, le recomendamos actualizar la versión de su servidor a o superior o desactivar el 5.0.9modo estricto para evitar errores.

Ver también

• Referencia del comandocount en el manual de MongoDB

• MongoDB\Collection::countDocuments()