Mongo.getReadPrefMode.txt

=======================
Mongo.getReadPrefMode()
=======================

.. default-domain:: mongodb

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

.. method:: Mongo.getReadPrefMode()

   :returns: The current :term:`read preference` mode for the
             :method:`Mongo() <db.getMongo()>` connection object.

   See :doc:`/core/read-preference` for an introduction to read
   preferences in MongoDB. Use :method:`~Mongo.getReadPrefMode()` to
   return the current read preference mode, as in the following
   example:

   .. code-block:: javascript

      db.getMongo().getReadPrefMode()

   Use the following operation to return and print the current read
   preference mode:

   .. code-block:: javascript

      print(db.getMongo().getReadPrefMode());

   This operation will return one of the following read preference
   modes:

   - :readmode:`primary`
   - :readmode:`primaryPreferred`
   - :readmode:`secondary`
   - :readmode:`secondaryPreferred`
   - :readmode:`nearest`

Compatibility
-------------

This method is available in deployments hosted in the following environments: 

.. include:: /includes/fact-environments-atlas-only.rst

.. include:: /includes/fact-environments-onprem-only.rst

.. seealso::

   - :doc:`/core/read-preference`
   - :method:`~cursor.readPref()`
   - :method:`~Mongo.setReadPref()`
   - :method:`~Mongo.getReadPrefTagSet()`