MongoDB\Collection::countDocuments()

Definición

MongoDB\Collection::countDocuments()

Cuente el número de documentos que cumplan con los criterios del filtro.

function countDocuments(array|object $filter = [], array $options = []): integer

Parámetros

$filter : arreglo|objeto

El criterio del filtro que especifica los documentos a contar.

$options : arreglo

Un arreglo que especifica las opciones deseadas.

Nombre	Tipo	Descripción
intercalación	arreglo|objeto	Intercalación permite a los usuarios especificar reglas específicas del lenguaje para la comparación de cadenas, tales como reglas para mayúsculas y tildes. Al especificar la intercalación, el campo locale es obligatorio; todos los demás campos de intercalación son opcionales. Para obtener descripciones de los campos, consulte Documento de intercalación. Si la intercalación no está especificada pero la colección tiene una intercalación predeterminada, la operación utiliza la intercalación especificada para la colección. Si no se especifica una intercalación para la colección o para la operación, MongoDB utiliza la comparación binaria simple utilizada en versiones anteriores para comparar cadenas.
comment	mixto	Permite a los usuarios especificar un comentario arbitrario para ayudar a rastrear la operación a través del perfilador de bases de datos, la salida actualOp() y registros. El comentario puede ser cualquier tipo válido de BSON a partir de MongoDB 4.4. Las versiones anteriores del servidor solo admiten valores de string.
hint	cadena|arreglo|objeto	El índice a utilizar. Especifique el nombre del índice como una string o el patrón clave del índice como un documento. Si se especifica, el sistema de query solo considerará los planes que utilicen el índice sugerido.
limit	entero	El número máximo de documentos coincidentes a devolver.
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.
Omitir	entero	El número de documentos coincidentes que se deben omitir antes de devolver resultados.

Return Values

El número de documentos que cumplen los criterios de filtrado.

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

Internamente, este método utiliza el operador de pipeline de agregación $group para obtener el resultado. Si se proporciona un parámetro filter, este se convierte en un operador de pipeline $match. Las etapas opcionales $skip y $limit se añaden entre $match y group si están presentes en las opciones.

Dado que este método utiliza una pipeline de agregación, no se pueden usar algunos operadores del query aceptados en un MongoDB\Collection::count() filter. Considere las siguientes alternativas a estos operadores restringidos:

Al evaluar los criterios de búsqueda, MongoDB compara tipos y valores según sus propias reglas de comparación para tipos BSON, que difieren de las reglas de comparación y manejo de tipos de PHP. Cuando se coincida con un tipo BSON especial, los criterios de consulta deben utilizar la Clase BSON respectiva en la extensión (por ejemplo, usa MongoDB\BSON\ObjectId para hacer coincidir con un ObjectId.

Ver también

• MongoDB\Collection::estimatedDocumentCount()