PHP 8.4.0 RC2 available for testing

MongoDB\Driver\Cursor::getId

(mongodb >=1.0.0)

MongoDB\Driver\Cursor::getIdRetourne l'ID de ce curseur

Description

final public MongoDB\Driver\Cursor::getId(bool $asInt64 = false): MongoDB\Driver\CursorId|MongoDB\BSON\Int64

Renvoie l'ID de ce curseur, qui identifie de manière unique le curseur sur le serveur.

Avertissement

Retourner un objet MongoDB\Driver\CursorId depuis cette méthode est DÉPRÉCIÉ depuis la version 1.20.0 de l'extension. Dans la version 2.0, l'argument asInt64 sera supprimé et cette méthode retournera toujours un objet MongoDB\BSON\Int64.

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

Renvoie l'ID de ce curseur. Si asInt64 est true, l'ID sera retourné sous la forme d'un objet MongoDB\BSON\Int64 ; sinon, il sera retourné sous la forme d'un objet MongoDB\Driver\CursorId et un avertissement de dépréciation sera émis.

Erreurs / Exceptions

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

Historique

Version Description
PECL mongodb 1.20.0 Dépréciation du retour d'un MongoDB\Driver\CursorId. Ajout de l'argument asInt64 pour faciliter la migration vers les versions futures. Si asInt64 est true, l'ID sera retourné sous la forme d'un MongoDB\BSON\Int64.

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(true));

?>

Résultat de l'exemple ci-dessus est similaire à :

object(MongoDB\BSON\Int64)#5 (1) {
  ["integer"]=>
  string(11) "94810124093"
}
add a note

User Contributed Notes

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