MongoDB\Driver\Cursor::getId

(mongodb >=1.0.0)

MongoDB\Driver\Cursor::getId — Retourne l'ID de ce curseur

Description

final public MongoDB\Driver\Cursor::getId ( void ) : MongoDB\Driver\CursorId

Retourne le MongoDB\Driver\CursorId associé à ce curseur. Un ID de curseur identifie de façon unique le curseur sur le serveur.

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

Retourne le MongoDB\Driver\CursorId associé à ce curseur.

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::getId()

<?php

/* Dans cet exemple, nous introduisons plusieurs documents dans la collection et 
 * spécifions un BatchSize plus petit pour garantir que le premier lot ne contient 
 * qu'un sous-ensemble de nos résultats et que le curseur reste ouvert sur le 
 * serveur. */
$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017");
$query = new MongoDB\Driver\Query([], ['batchSize' => 2]);

$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);
var_dump($cursor->getId());

?>

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

object(MongoDB\Driver\CursorId)#5 (1) {
  ["id"]=>
  int(94810124093)
}

Voir aussi