MongoDB\Client::getReadPreference()

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"
}

See Also

• Read Preference in the MongoDB manual

• MongoDB\Collection::getReadPreference()

• MongoDB\Database::getReadPreference()

• MongoDB\GridFS\Bucket::getReadPreference()