MongoDB\Client::getReadPreference()

For the complete MongoDB documentation index, see www.mongodb.com/docs/llms.txt

MongoDB\Client::getReadPreference()

New in version 1.2

Definition

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()](https://www.mongodb.com/docs/php-library/current/reference/method/mongodbcollection-getreadpreference.md#mongodb-phpmethod-phpmethod.MongoDB-Collection--getReadPreference--

  • [MongoDB\Database::getReadPreference()](https://www.mongodb.com/docs/php-library/current/reference/method/mongodbdatabase-getreadpreference.md#mongodb-phpmethod-phpmethod.MongoDB-Database--getReadPreference--

  • [MongoDB\GridFS\Bucket::getReadPreference()](https://www.mongodb.com/docs/php-library/current/reference/method/mongodbgridfsbucket-getreadpreference.md#mongodb-phpmethod-phpmethod.MongoDB-GridFS-Bucket--getReadPreference--