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\Database::getReadPreference()

New in version 1.2.

Definition

MongoDB\Database::getReadPreference

Returns the read preference for this database.

function getReadPreference(): MongoDB\Driver\ReadPreference

Return Values

A MongoDB\Driver\ReadPreference object.

Example

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