_i:W d Z ddlmZ ddlZddlmZ ddlmZmZm Z m
Z
m Z ddl m
Z
ddlmZ ddlmZmZ er dd lmZ dd
lmZ dZd Zd Zd
ZdZdZe e ef Z e e e ef Z d)dZ d*dZ d+dZ!d,dZ" G d d Z# G d de# Z$ G d de# Z% G d de# Z& G d d e# Z' G d d e# Z( G d d! Z)e$e%e&e'e(fZ* d- d.d"Z+d#Z, G d$ d% Z-d/d&Z. G d' d( Z/y)0zUtilities for choosing which member of a replica set to read from.
.. seealso:: This module is compatible with both the synchronous and asynchronous PyMongo APIs.
) annotationsN)abc)
TYPE_CHECKINGAnyMappingOptionalSequence)max_staleness_selectors)ConfigurationError) member_with_tags_server_selector#secondary_with_tags_server_selector) Selection)TopologyDescription )primaryprimaryPreferred secondarysecondaryPreferrednearestc | | S t | t t f st d| d t | dk( rt d| d | D ]+ }t |t j r t d|d t | S )z$Validate tag sets for a MongoClient.z Tag sets z invalid, must be a sequencer z: invalid, must be None or contain at least one set of tagszTag set zg invalid, must be an instance of dict, bson.son.SON or other type that inherits from collection.Mapping)
isinstancelisttuple TypeErrorlen
ValueErrorr r )tag_setstagss [/var/www/pod-logistic/pod-api/venv/lib/python3.12/site-packages/pymongo/read_preferences.py_validate_tag_setsr# 9 s hu
.)H c d| z S )Nz6maxStalenessSeconds must be a positive integer, not %s
max_stalenesss r" _invalid_max_staleness_msgr) P s
Cm SSr$ c | dk( ryt | t st t | | dk rt t | | S )zValidate max_staleness.r )r intr r) r r' s r" _validate_max_stalenessr- U sG mS )2=ABB3MBCC r$ c | yt | t st d| t j dt
d | S )zValidate hedge.Nz hedge must be a dictionary, not The read preference 'hedge' option is deprecated in PyMongo 4.12+ because hedged reads are deprecated in MongoDB version 8.0+. Support for 'hedge' will be removed in PyMongo 5.0.r
stacklevel)r dictr warningswarnDeprecationWarning)hedges r" _validate_hedger7 c sF } eT ":5)DEE MM }
Lr$ c e Zd ZdZdZ d ddZedd Zedd Zedd Z edd Z
edd Z edd
Z edd Z
edd Zdd
ZddZddZddZddZd dZy) _ServerModez$Base class for all read preferences.)
__mongos_mode__mode
__tag_sets__max_staleness__hedgeNc t | | _ || _ t | | _ t | | _ t | | _ y N)
_MONGOS_MODES_ServerMode__mongos_mode_ServerMode__moder# _ServerMode__tag_setsr- _ServerMode__max_stalenessr7 _ServerMode__hedge)selfmoder r( r6 s r" __init__z_ServerMode.__init__x s= +4 0 ,X6 6} E &u- r$ c . | j j S )z!The name of this read preference.) __class____name__rG s r" namez_ServerMode.name s ~~&&&r$ c | j S )z(The mongos mode of this read preference.)rB rM s r" mongos_modez_ServerMode.mongos_mode s !!!r$ c d| j i}| j di gfvr| j |d< | j dk7 r| j |d< | j di fvr| j |d< |S )z Read preference as a document.rH Nr! r+ maxStalenessSecondsr6 )rB rD rE rF )rG docs r" documentz_ServerMode.document st &t'9'9 : ??4", . //CK 2 %)-)=)=C% & <<bz ) <`_
)rD r rM s r" r z_ServerMode.tag_sets s ( )-tDOO$AbTAr$ c | j S )zThe maximum estimated length of time (in seconds) a replica set
secondary can fall behind the primary in replication before it will
no longer be selected for operations, or -1 for no maximum.
rE rM s r" r( z_ServerMode.max_staleness s ###r$ c j | j t j dt d | j S )am **DEPRECATED** - The read preference 'hedge' option is deprecated in PyMongo 4.12+ because hedged reads are deprecated in MongoDB version 8.0+. Support for 'hedge' will be removed in PyMongo 5.0.
The read preference ``hedge`` parameter.
A dictionary that configures how the server will perform hedged reads.
It consists of the following keys:
- ``enabled``: Enables or disables hedged reads in sharded clusters.
Hedged reads are automatically enabled in MongoDB 4.4+ when using a
``nearest`` read preference. To explicitly enable hedged reads, set
the ``enabled`` key to ``true``::
>>> Nearest(hedge={'enabled': True})
To explicitly disable hedged reads, set the ``enabled`` key to
``False``::
>>> Nearest(hedge={'enabled': False})
.. versionadded:: 3.11
r/ r r0 )rF r3 r4 r5 rM s r" r6 z_ServerMode.hedge s2 0 << # MM E"
||r$ c ( | j dk( rdS dS )a The wire protocol version the server must support.
Some read preferences impose version requirements on all servers (e.g.
maxStalenessSeconds requires MongoDB 3.4 / maxWireVersion 5).
All servers' maxWireVersion must be at least this read preference's
`min_wire_version`, or the driver raises
:exc:`~pymongo.errors.ConfigurationError`.
r+ r rX rM s r" min_wire_versionz _ServerMode.min_wire_version s ((B.q5A5r$ c z dj | j | j | j | j S )Nz1{}(tag_sets={!r}, max_staleness={!r}, hedge={!r}))formatrN rD rE rF rM s r" __repr__z_ServerMode.__repr__ s3 BII II OO LL
r$ c t |t rj| j |j k( xrO | j |j k( xr4 | j |j k( xr | j
|j
k( S t S r@ )r r9 rH r r( r6 NotImplementedrG others r" __eq__z_ServerMode.__eq__ sn e[ ) UZZ' .MMU^^3.&&%*=*==. JJ%++-
r$ c | |k( S r@ r& rb s r" __ne__z_ServerMode.__ne__ s 5= r$ c ` | j | j | j | j dS )zeReturn value of object for pickling.
Needed explicitly because __slots__() defined.
)rH r r( r6 )rC rD rE rF rM s r" __getstate__z_ServerMode.__getstate__ s, KK ! 1 1\\
r$ c |d | _ t | j | _ t |d | _ t |d | _ t |d | _ y)zRestore from pickling.rH r r( r6 N) rC rA rB r# rD r- rE r7 rF )rG values r" __setstate__z_ServerMode.__setstate__ sQ Fm *4;; 7,U:->? 6u_7M N &uW~6 r$ c |S r@ r& rG selections r" __call__z_ServerMode.__call__ s r$ Nr+ N)
rH r, r Optional[_TagSets]r( r, r6 Optional[_Hedge]returnNoners str)rs zdict[str, Any])rs r, )rs _TagSets)rs rr rc r rs bool)rj zMapping[str, Any]rs rt rn r rs r )rL
__module__ __qualname____doc__ __slots__rI propertyrN rP rT rH r r( r6 r\ r_ rd rf rh rk ro r& r$ r" r9 r9 s s
.WI
(, "& . . % . .
.
. ' ' " " B B* $ $ >
6
6
!
7r$ r9 c @ e Zd ZdZdZd fd ZddZd dZd
dZ xZ S ) PrimaryaG Primary read preference.
* When directly connected to one mongod queries are allowed if the server
is standalone or a replica set primary.
* When connected to a mongos queries are sent to the primary of a shard.
* When connected to a replica set queries are sent to the primary of
the replica set.
r& c , t | t y r@ )superrI _PRIMARY)rG rK s r" rI zPrimary.__init__$ s
"r$ c |j S z*Apply this read preference to a Selection.)primary_selectionrm s r" ro zPrimary.__call__' s ***r$ c y)Nz Primary()r& rM s r" r_ zPrimary.__repr__+ s r$ c T t |t r|j t k( S t S r@ )r r9 rH r ra rb s r" rd zPrimary.__eq__. s! e[ )::) ) r$ rs rt rz ru rx )
rL r{ r| r} r~ rI ro r_ rd
__classcell__rK s @r" r r s# I#+ r$ r c F e Zd ZdZdZ d d fd
ZddZ xZS )PrimaryPreferreda PrimaryPreferred read preference.
* When directly connected to one mongod queries are allowed to standalone
servers, to a replica set primary, or to replica set secondaries.
* When connected to a mongos queries are sent to the primary of a shard if
available, otherwise a shard secondary.
* When connected to a replica set queries are sent to the primary if
available, otherwise a secondary.
.. note:: When a :class:`~pymongo.mongo_client.MongoClient` is first
created reads will be routed to an available secondary until the
primary of the replica set is discovered.
:param tag_sets: The :attr:`~tag_sets` to use if the primary is not
available.
:param max_staleness: (integer, in seconds) The maximum estimated
length of time a replica set secondary can fall behind the primary in
replication before it will no longer be selected for operations.
Default -1, meaning no maximum. If it is set, it must be at least
90 seconds.
:param hedge: **DEPRECATED** - The :attr:`~hedge` for this read preference.
.. versionchanged:: 3.11
Added ``hedge`` parameter.
r& c 2 t | t ||| y r@ )r rI _PRIMARY_PREFERREDrG r r( r6 rK s r" rI zPrimaryPreferred.__init__Q s +X}eLr$ c |j r |j S t | j t j
| j | S z(Apply this read preference to Selection.)r r r
r r
selectr( rm s r" ro zPrimaryPreferred.__call__Y sB .. .6
6 = =d>P>PR[ \
r$ rp r rq r( r, r6 rr rs rt rz rL r{ r| r} r~ rI ro r r s @r" r r 4 sO 4 I (, "& M$M M M
Mr$ r c F e Zd ZdZdZ d d fd
ZddZ xZS ) Secondarya Secondary read preference.
* When directly connected to one mongod queries are allowed to standalone
servers, to a replica set primary, or to replica set secondaries.
* When connected to a mongos queries are distributed among shard
secondaries. An error is raised if no secondaries are available.
* When connected to a replica set queries are distributed among
secondaries. An error is raised if no secondaries are available.
:param tag_sets: The :attr:`~tag_sets` for this read preference.
:param max_staleness: (integer, in seconds) The maximum estimated
length of time a replica set secondary can fall behind the primary in
replication before it will no longer be selected for operations.
Default -1, meaning no maximum. If it is set, it must be at least
90 seconds.
:param hedge: **DEPRECATED** - The :attr:`~hedge` for this read preference.
.. versionchanged:: 3.11
Added ``hedge`` parameter.
r& c 2 t | t ||| y r@ )r rI
_SECONDARYr s r" rI zSecondary.__init__{ s X}eDr$ c j t | j t j | j | S r )r
r r
r r( rm s r" ro zSecondary.__call__ s, 2 MM299$:L:LiX
r$ rp r rz r r s @r" r r c sO * I (, "& E$E E E
E
r$ r c F e Zd ZdZdZ d d fd
ZddZ xZS )SecondaryPreferreda SecondaryPreferred read preference.
* When directly connected to one mongod queries are allowed to standalone
servers, to a replica set primary, or to replica set secondaries.
* When connected to a mongos queries are distributed among shard
secondaries, or the shard primary if no secondary is available.
* When connected to a replica set queries are distributed among
secondaries, or the primary if no secondary is available.
.. note:: When a :class:`~pymongo.mongo_client.MongoClient` is first
created reads will be routed to the primary of the replica set until
an available secondary is discovered.
:param tag_sets: The :attr:`~tag_sets` for this read preference.
:param max_staleness: (integer, in seconds) The maximum estimated
length of time a replica set secondary can fall behind the primary in
replication before it will no longer be selected for operations.
Default -1, meaning no maximum. If it is set, it must be at least
90 seconds.
:param hedge: **DEPRECATED** - The :attr:`~hedge` for this read preference.
.. versionchanged:: 3.11
Added ``hedge`` parameter.
r& c 2 t | t ||| y r@ )r rI _SECONDARY_PREFERREDr s r" rI zSecondaryPreferred.__init__ s -x Nr$ c t | j t j | j | }|r|S |j
S r )r
r r
r r( r )rG rn secondariess r" ro zSecondaryPreferred.__call__ s@ 9 MM299$:L:LiX
.. .r$ rp r rz r r s @r" r r sO 2 I (, "& O$O O O
O /r$ r c F e Zd ZdZdZ d d fd
ZddZ xZS )Nearestay Nearest read preference.
* When directly connected to one mongod queries are allowed to standalone
servers, to a replica set primary, or to replica set secondaries.
* When connected to a mongos queries are distributed among all members of
a shard.
* When connected to a replica set queries are distributed among all
members.
:param tag_sets: The :attr:`~tag_sets` for this read preference.
:param max_staleness: (integer, in seconds) The maximum estimated
length of time a replica set secondary can fall behind the primary in
replication before it will no longer be selected for operations.
Default -1, meaning no maximum. If it is set, it must be at least
90 seconds.
:param hedge: **DEPRECATED** - The :attr:`~hedge` for this read preference.
.. versionchanged:: 3.11
Added ``hedge`` parameter.
r& c 2 t | t ||| y r@ )r rI _NEARESTr s r" rI zNearest.__init__ s 8]EBr$ c j t | j t j | j | S r )r r r
r r( rm s r" ro zNearest.__call__ s, / MM299$:L:LiX
r$ rp r rz r r s @r" r r sO * I (, "& C$C C C
C
r$ r c < e Zd ZdZdZd dZd
dZd dZd dZd
dZ y)
_AggWritePrefzAgg $out/$merge write preference.
* If there are readable servers and there is any pre-5.0 server, use
primary read preference.
* Otherwise use `pref` read preference.
:param pref: The read preference to use on MongoDB 5.0+.
)prefeffective_prefc < || _ t j | _ y r@ )r ReadPreferencePRIMARYr )rG r s r" rI z_AggWritePref.__init__ s +9+A+Ar$ c |j }|j t j r |r|dk rt j | _ y | j | _ y )N
)common_wire_versionhas_readable_serverr PRIMARY_PREFERREDr r r )rG topology_description common_wvs r" selection_hookz _AggWritePref.selection_hook sE (<< 4 4^5U5U VB"0"8"8D "&))D r$ c $ | j | S r )r rm s r" ro z_AggWritePref.__call__ s ""9--r$ c " d| j dS )Nz_AggWritePref(pref=))r rM s r" r_ z_AggWritePref.__repr__ s $TYYM33r$ c . t | j | S r@ )getattrr )rG rN s r" __getattr__z_AggWritePref.__getattr__ s t**D11r$ N)r r9 )r r rs rt rz ru )rN rv rs r )
rL r{ r| r} r~ rI r ro r_ r r& r$ r" r r s( +IB ,.4
2r$ r c | t k( r,|d i gfvr t d |dk7 r t d t S t | || S )Nz4Read preference primary cannot be combined with tagsr+ zCRead preference primary cannot be combined with maxStalenessSeconds)r r r _ALL_READ_PREFERENCES)rH r r( s r" make_read_preferencer sZ x D2$< '$%[\ \ B $U
y &x ??r$ )r r SECONDARYSECONDARY_PREFERREDNEARESTc V e Zd ZdZ e Z e Z e Z e
Z e Z
y)r a An enum that defines some commonly used read preference modes.
Apps can also create a custom read preference, for example::
Nearest(tag_sets=[{"node":"analytics"}])
See `Read and Write Settings `_ for code examples.
A read preference is used in three cases:
:class:`~pymongo.mongo_client.MongoClient` connected to a single mongod:
- ``PRIMARY``: Queries are allowed if the server is standalone or a replica
set primary.
- All other modes allow queries to standalone servers, to a replica set
primary, or to replica set secondaries.
:class:`~pymongo.mongo_client.MongoClient` initialized with the
``replicaSet`` option:
- ``PRIMARY``: Read from the primary. This is the default, and provides the
strongest consistency. If no primary is available, raise
:class:`~pymongo.errors.AutoReconnect`.
- ``PRIMARY_PREFERRED``: Read from the primary if available, or if there is
none, read from a secondary.
- ``SECONDARY``: Read from a secondary. If no secondary is available,
raise :class:`~pymongo.errors.AutoReconnect`.
- ``SECONDARY_PREFERRED``: Read from a secondary if available, otherwise
from the primary.
- ``NEAREST``: Read from any member.
:class:`~pymongo.mongo_client.MongoClient` connected to a mongos, with a
sharded cluster of replica sets:
- ``PRIMARY``: Read from the primary of the shard, or raise
:class:`~pymongo.errors.OperationFailure` if there is none.
This is the default.
- ``PRIMARY_PREFERRED``: Read from the primary of the shard, or if there is
none, read from a secondary of the shard.
- ``SECONDARY``: Read from a secondary of the shard, or raise
:class:`~pymongo.errors.OperationFailure` if there is none.
- ``SECONDARY_PREFERRED``: Read from a secondary of the shard if available,
otherwise from the shard primary.
- ``NEAREST``: Read from any shard member.
N)rL r{ r| r} r r r r r r r r r r r& r$ r" r r # s1 4l iG(* I,.iGr$ r c , t j | S )z2Get the read preference mode from mongos/uri name.)rA index)rN s r" read_pref_mode_from_namer a s t $$r$ c < e Zd ZU dZded< d dZd
dZd dZd dZy)
MovingAveragez0Tracks an exponentially-weighted moving average.Optional[float]averagec d | _ y r@ r rM s r" rI zMovingAverage.__init__k r$ c |dk rt d| | j || _ y d| j z d|z z | _ y )Nr z duration cannot be negative g?g?)r r )rG samples r"
add_samplezMovingAverage.add_samplen sH A: ;F8 DE E << !DL -f r sM
# B B + -
2@
c GCH% &.T
b bJ k 8,{ ,^$
$
N-/ -/`$
k $
N%2 %2P !"2I?QSZ[ CE @
@+ @