MongoCursor::getReadPreference

(PECL mongo >=1.3.3)
Get the read preference for this query
public array MongoCursor::getReadPreference ( void )
Returns:

This function returns an array describing the read preference. The array contains the values type for the string read preference mode (corresponding to the MongoClient constants), and tagsets containing a list of all tag set criteria. If no tag sets were specified, tagsets will not be present in the array.

Examples:
MongoCursor::getReadPreference() return value example
<?php

$m = new MongoClient();
$cursor = $m->test->users->find();
$cursor->setReadPreference(MongoClient::RP_SECONDARY, array(
    array('dc' => 'east', 'use' => 'reporting'),
    array('dc' => 'west'),
    array(),
));
var_dump($cursor->getReadPreference());
?>

The above example will output:

array(2) {
  ["type"]=>
  string(9) "secondary"
  ["tagsets"]=>
  array(3) {
    [0]=>
    array(2) {
      ["dc"]=>
      string(4) "east"
      ["use"]=>
      string(9) "reporting"
    }
    [1]=>
    array(1) {
      ["dc"]=>
      string(7) "west"
    }
    [2]=>
    array(0) {
    }
  }
}
See also:

read preferences -

MongoCursor::setReadPreference() -

MongoCursorInterface::getReadPreference() -

doc_php
2016-02-24 16:20:42
Comments
Leave a Comment

Please login to continue.