MongoDBClient-getReadPreference.txt

====================================
MongoDB\\Client::getReadPreference()
====================================

.. meta::
   :description: Retrieve the read preference setting for a Client with the MongoDB PHP Library.

.. versionadded:: 1.2


.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

Definition
----------

.. phpmethod:: MongoDB\Client::getReadPreference()

   Returns the read preference for this client.

   .. code-block:: php

      function getReadPreference(): MongoDB\Driver\ReadPreference

Return Values
-------------

A :php:`MongoDB\Driver\ReadPreference <class.mongodb-driver-readpreference>`
object.

Example
-------

.. code-block:: php

   <?php

   $client = new MongoDB\Client('mongodb://127.0.0.1/', [
       'readPreference' => 'primaryPreferred',
   ]);

   var_dump($client->getReadPreference());

The output would then resemble:

.. code-block:: none

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

See Also
--------

- :manual:`Read Preference </reference/read-preference>` in the MongoDB manual
- :phpmethod:`MongoDB\Collection::getReadPreference()`
- :phpmethod:`MongoDB\Database::getReadPreference()`
- :phpmethod:`MongoDB\GridFS\Bucket::getReadPreference()`