MongoDB\Collection::count()

Definición

MongoDB\Collection::count()

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

function count(
    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	Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the locale field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document. 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. 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. Nuevo en la versión 1.13.
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. Modificado en la versión 1.2: Si se proporciona un documento, se pasa al comando tal cual. Anteriormente, la librería convertía el patrón de clave en un nombre de índice.
limit	entero	El número máximo de documentos coincidentes a devolver.
maxTimeMS	entero	El límite de tiempo acumulativo en milisegundos para las operaciones de procesamiento en el cursor. MongoDB aborta la operación lo antes posible tras el 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. Nuevo en la versión 1.3.
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

This method is deprecated and cannot be executed within a transaction. It has always been implemented using the count command. The behavior of the count command differs depending on the options passed to it and may or may not provide an accurate count. When no query filter is provided, the count command provides an estimate using collection metadata. Even when provided with a query filter the count command can return inaccurate results with a sharded cluster if orphaned documents exist or if a chunk migration is in progress. The MongoDB\Collection::countDocuments() method avoids these sharded cluster problems entirely.

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

• Referencia del comando count en el manual de MongoDB

• MongoDB\Collection::countDocuments()

• MongoDB\Collection::estimatedDocumentCount()