MongoCommandCursor::createFromDocument

(PECL mongo >=1.5.0)

MongoCommandCursor::createFromDocument — Crée un nouveau curseur de commande depuis un document de commande existant

Description

public static MongoCommandCursor::createFromDocument ( MongoClient $connection , string $hash , array $document ) : MongoCommandCursor

Utilisez cette méthode si vous avez un résultat de commande brute qui contient des informations de curseur. Notez que les curseurs créés avec cette méthode ne peuvent pas être parcouru plusieurs fois, sachant qu'ils perdent la commande originale nécessaire à la ré-exécution.

Liste de paramètres

connection: La connexion à la base de données.
hash: Le hash de la connexion, tel qu'obtenu via le troisième argument par référence de la méthodec MongoDB:command().
document: Document contenant les informations du curseur. Ce document doit contenir les champs id, ns et firstBatch. Un tel document est obtenu par appel à la méthode MongoDB:command() avec les arguments appropriés à retourner au curseur, et pas seulement un résultat. Voir l'exemple ci-dessous.

Valeurs de retour

Retourne le nouveau curseur.

Exemples

Exemple #1 Exemple avec MongoCommandCursor::createFromDocument()


<?php
$m = new MongoClient;
$d = $m->demo;

// Définit le pipeline d'agrégation
$pipeline = [
    [ '$group' => [
        '_id' => '$country_code',
        'timezones' => [ '$addToSet' => '$timezone' ]
    ] ],
    [ '$sort' => [ '_id' => 1 ] ],
];


// Exécution de la commande. L'option "cursor" ci-dessous indique au serveur
// de retourner un document d'information de curseur plutôt que des résultats
$r = $d->command(
    [
        'aggregate' => 'cities',
        'pipeline' => $pipeline,
        'cursor' => [ 'batchSize' => 1 ],
    ],
    null,
    $hash
);

// Affiche les résultats ainsi que le hash
var_dump( $r, $hash );

// Construit le curseur de commande
$cursor = MongoCommandCursor::createFromDocument( $m, $hash, $r );
?>

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

array(2) {
  ["cursor"]=>
  array(3) {
    ["id"]=>
    object(MongoInt64)#5 (1) {
      ["value"]=>
      string(12) "392143983421"
    }
    ["ns"]=>
    string(11) "demo.cities"
    ["firstBatch"]=>
    array(1) {
      [0]=>
      array(2) {
        ["_id"]=>
        string(2) "AD"
        ["timezones"]=>
        array(1) {
          [0]=>
          string(14) "Europe/Andorra"
        }
      }
    }
  }
  ["ok"]=>
  float(1)
}
string(25) "localhost:27017;-;.;17617"

Comme vous pouvez le voir, les informations de curseur retournées contiennent les champs id, ns et firstBatch.

Voir aussi

MongoCommandCursor::__construct() - Crée un nouveau curseur de commande