MongoDB\Driver\Cursor::isDead

(mongodb >=1.0.0)

MongoDB\Driver\Cursor::isDead — Vérifie si le curseur peut avoir des résultats supplémentaires

Description

final public MongoDB\Driver\Cursor::isDead ( void ) : bool

Vérifie si le curseur peut avoir des résultats supplémentaires disponibles à lire. Un curseur est initialement "alive" mais peut devenir "dead" pour l'une des raisons suivantes :

  • L'avancement d'un curseur "non-tailable" n'a pas retourné un document
  • Le curseur a rencontré une erreur
  • Le curseur a lu son dernier lot à l'achèvement
  • Le curseur a atteint sa limite configurée
Ceci est principalement utile avec les curseurs de queue.

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

Retourne TRUE si des résultats supplémentaires ne sont pas disponibles, et FALSE sinon.

Erreurs / Exceptions

  • Lance une exception MongoDB\Driver\InvalidArgumentException lors d'une erreur survenue pendant l'analyse d'un argument.

Exemples

Exemple #1 Exemple avec MongoDB\Driver\Cursor::isDead()

<?php

$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017");
$query = new MongoDB\Driver\Query([]);

$bulk = new MongoDB\Driver\BulkWrite;
$bulk->insert(['x' => 1]);
$bulk->insert(['x' => 2]);
$bulk->insert(['x' => 3]);
$manager->executeBulkWrite('db.collection', $bulk);

$cursor = $manager->executeQuery('db.collection', $query);

$iterator = new IteratorIterator($cursor);

$iterator->rewind();
var_dump($cursor->isDead());

$iterator->next();
var_dump($cursor->isDead());

$iterator->next();
var_dump($cursor->isDead());

$iterator->next();
var_dump($cursor->isDead());

?>

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

bool(false)
bool(false)
bool(false)
bool(true)