MongoDB\Collection::countDocuments()

Definición

MongoDB\Collection::countDocuments()

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

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

Parámetros

$filter : matriz|objeto

Los criterios de filtro que especifican los documentos a contar.

$options : matriz

Una matriz que especifica las opciones deseadas.

Nombre	Tipo	Descripción
intercalación	matriz|objeto	Laintercalación permite a los usuarios especificar reglas específicas del idioma para la comparación de cadenas, como el uso de mayúsculas y minúsculas y tildes. Al especificar la intercalación, el locale campo es obligatorio; todos los demás campos son opcionales. Para obtener descripciones de los campos, consulte el documento de intercalación. Si no se especifica la intercalación, pero la colección tiene una predeterminada, la operación utiliza la intercalación especificada para la colección. Si no se especifica ninguna intercalación para la colección ni para la operación, MongoDB utiliza la comparación binaria simple utilizada en versiones anteriores para las comparaciones de cadenas.
comment	mixto	Permite a los usuarios especificar un comentario arbitrario para ayudar a rastrear la operación a través del generador de perfiles de base de datos, la salidacurrentOp y los registros. El comentario puede ser cualquier tipo BSON válido a partir de MongoDB 4.4. Las versiones anteriores del servidor solo admiten valores de cadena.
hint	cadena|matriz|objeto	El índice a utilizar. Especifique el nombre del índice como una cadena o el patrón de clave del índice como un documento. Si se especifica, el sistema de consultas 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 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.
Omitir	entero	La cantidad de documentos coincidentes que se deben omitir antes de devolver resultados.

Return Values

El número de documentos que coinciden con los criterios de filtro.

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

Internamente, este método utiliza el operador de canalización de agregación $group para obtener el resultado. Si se proporciona un parámetro filter, este se convierte en un operador de canalización $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 canalización de agregación, algunos operadores de consulta aceptados dentro de un MongoDB\Collection::count() filter no se pueden usar. 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()