Please wait while we load your page...


PHP Manual :: MongoCursor::getReadPreference

MongoCursor::getNext || MongoCursor::hasNext || MongoCursor || PHP Manual

(PECL mongo >=1.3.3)

MongoCursor::getReadPreferenceGet the read preference for this query


public array MongoCursor::getReadPreference ( void )


This function has no parameters.

Return Values

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.


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


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

The above example will output:

array(2) {
  string(9) "secondary"
  array(3) {
    array(2) {
      string(4) "east"
      string(9) "reporting"
    array(1) {
      string(7) "west"
    array(0) {

See Also

MongoCursor::getNext || MongoCursor::hasNext || MongoCursor || PHP Manual
Live Chat Not Available