MongoCollection::count

(PECL mongo >=0.9.0)

MongoCollection::countCompte le nombre de documents de cette collection

Description

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

Liste de paramètres

query

Tableau associatif ou objet avec les champs à chercher.

options

Un tableau d'options pour la création de l'index. Les options actuellement disponibles sont :

Nom Type Description
hint mixed

L'index à utiliser pour la requête. Si une chaîne est passée, elle doit correspondre au nom de l'index. Si un tableau ou un objet est passé, il doit correspondre à la spécification utilisée pour créer l'index (i.e. le premier argument de MongoCollection::createIndex()).

Cette option est uniquement supportée en MongoDB 2.6+.
limit integer Le nombre maximal de documents qui correspond à retourner.
maxTimeMS integer

Spécifie une durée limite cumulative, en millisecondes, pour réaliser l'opération (n'incluant pas la durée d'inactivité). Si l'opération n'est pas terminée pendant la durée maximale, une exception de type MongoExecutionTimeoutException sera émise.

Cette option n'est supporté qu'en MongoDB 2.6+.
skip integer Le nombre de documents qui correspond à ignorer avant de retourner les résultats.

Valeurs de retour

Retourne le nombre de documents correspondant à la requête.

Erreurs / Exceptions

Lance une exception de type MongoResultException si le serveur ne peut pas exécuter la commande en raison d'une erreur.

Lance une exception MongoExecutionTimeoutException si l'exécution de la commande s'est terminée en raison d'un maxTimeMS.

Historique

Version Description
1.6.0 Le second paramètre est maintenant un tableau d'options. Le fait de passer les paramètres limit et skip comme second et troisième paramètres, respectivement, est maintenant obsolète.
1.0.7 Ajout des paramètres limit et skip comme second et troisième paramètres, respectivement.

Exemples

Exemple #1 Exemple avec 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)));

?>

L'exemple ci-dessus va afficher quelque chose de similaire à :

int(3)
int(1)
add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top