MongoCommandCursor::getReadPreference

(PECL mongo >=1.6.0)

MongoCommandCursor::getReadPreference — Get the read preference for this command

Descrierea

public MongoCommandCursor::getReadPreference ( ) : array

Parametri

Această funcție nu are parametri.

Valorile întoarse

Această funcție întoarce un tablou ce descrie preferința de citire. Tabloul conține tipul (type) valorilor pentru șirul cu modul preferinței de citire (ce corespunde constantelor MongoClient), și tagsets conținând lista tuturor criteriilor setului de etichete. Dacă nu a fost specificat nici un set de etichete, tagsets nu va fi prezent în tablou.

Exemple

Example #1 MongoCommandCursor::getReadPreference() return value example


<?php

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

// If a MongoCommandCursor is constructed directly, it will inherit the read
// preference of the MongoClient instance passed to its constructor; however,
// MongoCollection::aggregateCursor() will have the MongoCommandCursor inherit
// the collection's read preference.
$collection->setReadPreference(MongoClient::RP_SECONDARY);

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

var_dump($cursor->getReadPreference());

?>

Exemplul de mai sus va afișa:

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

A se vedea și

The read preferences documentation.
MongoCommandCursor::setReadPreference() - Set the read preference for this command
MongoCursorInterface::getReadPreference() - Get the read preference for this query

add a note

User Contributed Notes

There are no user contributed notes for this page.