Navigation
This version of the documentation is archived and no longer supported. To learn how to upgrade your version of PHP Library Manual, refer to the upgrade documentation.

MongoDB\Client::getReadPreference()

New in version 1.2.

Definition

MongoDB\Client::getReadPreference

Returns the read preference for this client.

function getReadPreference(): MongoDB\Driver\ReadPreference

Return Values

A MongoDB\Driver\ReadPreference object.

Example

<?php

$client = new MongoDB\Client('mongodb://127.0.0.1/', [
    'readPreference' => 'primaryPreferred',
]);

var_dump($client->getReadPreference());

The output would then resemble:

object(MongoDB\Driver\ReadPreference)#5 (1) {
  ["mode"]=>
  string(16) "primaryPreferred"
}