• API Documentation >
• MongoDB\Collection Class >
• MongoDB\Collection::getReadPreference()

MongoDB\Collection::getReadPreference()

New in version 1.2.

Definition

MongoDB\Collection::getReadPreference

Returns the read preference for this collection.

copy

function getReadPreference(): MongoDB\Driver\ReadPreference

Return Values

A MongoDB\Driver\ReadPreference object.

Example

copy

<?php

$collection = (new MongoDB\Client)->selectCollection('test', 'users', [
    'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'),
]);

var_dump($collection->getReadPreference());

The output would then resemble:

copy

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

See Also

• Read Preference in the MongoDB manual
• MongoDB\Client::getReadPreference()
• MongoDB\Database::getReadPreference()
• MongoDB\GridFS\Bucket::getReadPreference()

←   MongoDB\Collection::getReadConcern() MongoDB\Collection::getTypeMap()  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.