MongoCursor::info

(PECL mongo >=1.0.5)

MongoCursor::info — Récupère les informations sur la création du curseur et son itération

Description

public MongoCursor::info ( void ) : array

Cette méthode peut être appelée avant ou après le début de l'itération du curseur.

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

Retourne les champs namespace, batch size, limit, skip, flags, query, et projected de ce curseur. Si le curseur a commencé son itération, d'autres informations seront disponibles sur l'itération et la connexion.

Historique

Version Description
1.1.0 Ajout de quelques champs, incluant id (l'identifiant de curseur), at (le compteur du driver du document courant), numReturned (le nombre retourné par le serveur dans le batch courant), et server (le serveur sur lequel la requête a été émise ; utile en plus de Préférences de lecture).
1.0.10 Ajout du champ started_iterating, un booléen indiquant si le curseur est antérieur ou postérieur à la requête.

Exemples

Exemple #1 Exemple avec MongoCursor::info()

<?php
$m = new MongoClient();

$cursor = $m->test->foo->find(array("x" => 4), array("y" => 0));

echo "Avant le début de l'itération :\n";
var_dump($cursor->info());

echo "\nAprès le début de l'itération :\n";
$cursor->rewind();
var_dump($cursor->info());

?>

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

Avant le début de l'itération :
array(8) {
  ["ns"]=>
  string(8) "test.foo"
  ["limit"]=>
  int(0)
  ["batchSize"]=>
  int(0)
  ["skip"]=>
  int(0)
  ["flags"]=>
  int(0)
  ["query"]=>
  array(1) {
    ["x"]=>
    int(4)
  }
  ["fields"]=>
  array(1) {
    ["y"]=>
    int(0)
  }
  ["started_iterating"]=>
  bool(false)
}

Après le début de l'itération :
array(15) {
  ["ns"]=>
  string(8) "test.foo"
  ["limit"]=>
  int(0)
  ["batchSize"]=>
  int(0)
  ["skip"]=>
  int(0)
  ["flags"]=>
  int(0)
  ["query"]=>
  array(1) {
    ["x"]=>
    int(4)
  }
  ["fields"]=>
  array(1) {
    ["y"]=>
    int(0)
  }
  ["started_iterating"]=>
  bool(true)
  ["id"]=>
  int(0)
  ["at"]=>
  int(0)
  ["numReturned"]=>
  int(1)
  ["server"]=>
  string(25) "localhost:27017;-;.;26450"
  ["host"]=>
  string(9) "localhost"
  ["port"]=>
  int(27017)
  ["connection_type_desc"]=>
  string(10) "STANDALONE"
}

Voir aussi