Navigation
This version of the documentation is archived and no longer supported.
Server Selection Algorithm
MongoDB drivers use a Server Selection algorithm to choose which
replica set member to use or, when connected to multiple
mongos
instances, which mongos
instance to use.
Server selection occurs once per operation.
Read Preference for Replica Sets
Server selection occurs once per operation and is governed by the
read preference and localThresholdMS
settings.
The read preference is re-evaluated for each operation.
Read Preference |
Selection Process |
primary (Default) |
- The driver selects the primary.
|
secondary |
- The driver assembles a list of eligible secondary members.
Tag sets
and read concern can further
restrict the eligibility of the members.
- If the list of eligible members is not empty, the driver
determines which eligible member is the “closest” (i.e. the
member with the lowest average network round-trip-time) and
calculates a latency window by adding the average
round-trip-time of this “closest” server and the
localThresholdMS . The driver uses this latency window to
pare down the list of eligible members to those members that
fall within this window.
- From this list of eligible members that fall within the
latency window, the driver randomly chooses an eligible member.
|
nearest |
- The driver assembles a list of eligible members (primary and
secondaries). Tag sets and read
concern can further limit the
eligibility of the members.
- If the list of eligible members is not empty, the driver
determines which eligible member is the “closest” (i.e. the
member with the lowest average network round-trip-time) and
calculates a latency window by adding the average
round-trip-time of this “closest” server and the
localThresholdMS . The driver uses
this latency window to pare down the list of eligible members
to those members that fall within this window.
- From this list of eligible members that fall within the
latency window, the driver randomly chooses an eligible member.
|
primaryPreferred |
- If the primary is available, driver selects the primary.
- Otherwise, server selection follows the process for the read
preference
secondary .
|
secondaryPreferred |
- Following the server selection process for the for the read
preference
secondary , if a list of eligible secondary
members is non-empty, driver chooses an eligible secondary member.
- Otherwise, if the list is empty, driver selects the primary.
|
Read Preference for Sharded Clusters
Load Balancing
If there is more than one mongos
instances in the connection
seed list, the driver determines which mongos
is the
“closest” (i.e. the member with the lowest average network
round-trip-time) and calculates the latency window by adding the
average round-trip-time of this “closest” mongos
instance
and the localThresholdMS
. The driver will load balance randomly
across the mongos
instances that fall within the latency
window.
Read Preference and Shards
For sharded clusters that have replica set shards, mongos
applies the read preference when reading from the shards. Server
selection is governed by the read preference and replication.localPingThresholdMs
settings.
Changed in version 3.0.0: The read preference is re-evaluated for each operation.
Read Preference |
Selection Process |
primary (Default) |
- The
mongos selects the primary.
|
secondary |
- The
mongos assembles a list of eligible secondary members.
Tag sets
and read concern can further
restrict the eligibility of the members.
- If the list of eligible members is not empty, the
mongos
determines which eligible member is the “closest” (i.e. the
member with the lowest average network round-trip-time) and
calculates a latency window by adding the average
round-trip-time of this “closest” server and the
replication.localPingThresholdMs (or --localThreshold command line option). The mongos uses this latency window to
pare down the list of eligible members to those members that
fall within this window.
- From this list of eligible members that fall within the
latency window, the
mongos randomly chooses an eligible member.
|
nearest |
- The
mongos assembles a list of eligible members (primary and
secondaries). Tag sets and read
concern can further limit the
eligibility of the members.
- If the list of eligible members is not empty, the
mongos
determines which eligible member is the “closest” (i.e. the
member with the lowest average network round-trip-time) and
calculates a latency window by adding the average
round-trip-time of this “closest” server and the
replication.localPingThresholdMs (or --localThreshold command line option) . The mongos uses
this latency window to pare down the list of eligible members
to those members that fall within this window.
- From this list of eligible members that fall within the
latency window, the
mongos randomly chooses an eligible member.
|
primaryPreferred |
- If the primary is available,
mongos selects the primary.
- Otherwise, server selection follows the process for the read
preference
secondary .
|
secondaryPreferred |
- Following the server selection process for the for the read
preference
secondary , if a list of eligible secondary
members is non-empty, mongos chooses an eligible secondary member.
- Otherwise, if the list is empty,
mongos selects the primary.
|