MongoCommandCursor::getReadPreference

(PECL mongo >=1.6.0)

MongoCommandCursor::getReadPreference — Récupère les préférences de lecture pour cette commande

Description

public array MongoCommandCursor::getReadPreference ( void )

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

Cette fonction retourne un tableau décrivant les préférences de lecture. Ce tableau contient les valeurs type contenant une chaîne représentant le mode de préférence de lecture (suivant les MongoClient), et tagsets contenant une liste de tous les critères du jeu de tags. Si aucun jeu de tags n'est spécifié, tagsets ne sera pas présent dans ce tableau.

Exemples

Exemple #1 Exemple de valeur retournée par MongoCommandCursor::getReadPreference()

<?php

$m = new MongoClient('mongodb://rs1.example.com:27017', array('replicaSet' => 'myReplSetName'));
$collection = $m->selectCollection('test', 'people');

// Si un MongoCommandCursor est directement construit, il va hériter des
// préférences de lecture de l'instance MongoClient passé au constructeur ;
// cependant, MongoCollection::aggregateCursor() va recevoir l'héritage
// de MongoCommandCursor des préférences de lecture de la collection.
$collection->setReadPreference(MongoClient::RP_SECONDARY);

$cursor = $collection->aggregateCursor( [
    [ '$group' => [ '_id' => '$name', 'points' => [ '$sum' => '$points' ] ] ],
    [ '$sort' => [ 'points' => -1 ] ],
] );

var_dump($cursor->getReadPreference());

?>

L'exemple ci-dessus va afficher :

array(1) {
  ["type"]=>
  string(9) "secondary"
}

Voir aussi