MongoCollection::count

(PECL mongo >=0.9.0)

MongoCollection::countCuenta el número de documentos de esta colección

Descripción

public MongoCollection::count ([ array $query = array() [, array $options = array() ]] ) : int

Parámetros

query

Array asociativo u objeto con los campos que deben coincidir.

options

Un array de opciones para creación del índice. Las opciones disponibles actualmente son:

Nombre Tipo Descripción
hint mixed

Índice para la consulta. Si se pasa un string, debería corresponderse con un nombre de índice. Si se pasa un array y objeto, debería corresponderse con la especificación empelada al crear el índice (esto es, el primer argumento de MongoCollection::createIndex()).

Esta opción solamente está soportada en MongoDB 2.6+.
limit integer El número máximo de documentos coincidentes a devolver.
maxTimeMS integer

Especifica un límite de tiempo acumulativo en milisegundos para el procesamiento de la operación (no incluye tiempo inactivo). Si la operación no se completa dentro del período de espera, se lanzará una MongoExecutionTimeoutException.

Esta opción solamente está soportada en MongoDB 2.6+.
skip integer El número de documentos coincidentes a saltarse antes de devolver los resultados.

Valores devueltos

Devuelve el número de documentos que coinciden con la consulta.

Errores/Excepciones

Lanza una MongoResultException si el servidor no pudo ejecutar el comando debido a un error.

Lanza una MongoExecutionTimeoutException si la ejecución del comando finalizó debido a maxTimeMS.

Historial de cambios

Versión Descripción
1.6.0 El segundo parámetro ahora es el array de opciones options. Pasar limit y skip como segundo y tercer parámetros, respectivamente, ahora está obsoleto.
1.0.7 Se añadieron los parámetros limit y skip como segundo y tercer parámetros, respectivamente.

Ejemplos

Ejemplo #1 Ejemplo de MongoCollection::count()

<?php

$collection
->insert(array('x'=>1));
$collection->insert(array('x'=>2));
$collection->insert(array('x'=>3));

var_dump($collection->count());
var_dump($collection->count(array('x'=>1)));

?>

El resultado del ejemplo sería algo similar a:

int(3)
int(1)