Docs Menu

Docs HomePHP Library Manual

MongoDB\Database::getReadPreference()

On this page

  • Definition
  • Return Values
  • Example
  • See Also

New in version 1.2.

MongoDB\Database::getReadPreference()

Returns the read preference for this database.

function getReadPreference(): MongoDB\Driver\ReadPreference

A MongoDB\Driver\ReadPreference object.

<?php
$database = (new MongoDB\Client)->selectDatabase('test', [
'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'),
]);
var_dump($database->getReadPreference());

The output would then resemble:

object(MongoDB\Driver\ReadPreference)#5 (1) {
["mode"]=>
string(16) "primaryPreferred"
}
←  MongoDB\Database::getReadConcern()MongoDB\Database::getTypeMap() →