OpenQuizz
Une application de gestion des contenus pédagogiques
TopologyDescription Class Reference
Inheritance diagram for TopologyDescription:
Collaboration diagram for TopologyDescription:

Public Member Functions

def __init__ (self, topology_type, server_descriptions, replica_set_name, max_set_version, max_election_id, topology_settings)
 
def check_compatible (self)
 
def has_server (self, address)
 
def reset_server (self, address)
 
def reset (self)
 
def server_descriptions (self)
 
def topology_type (self)
 
def topology_type_name (self)
 
def replica_set_name (self)
 
def max_set_version (self)
 
def max_election_id (self)
 
def logical_session_timeout_minutes (self)
 
def known_servers (self)
 
def has_known_servers (self)
 
def readable_servers (self)
 
def common_wire_version (self)
 
def heartbeat_frequency (self)
 
def apply_selector (self, selector, address, custom_selector=None)
 
def has_readable_server (self, read_preference=ReadPreference.PRIMARY)
 
def has_writable_server (self)
 
def __repr__ (self)
 

Data Fields

 topology_type
 

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  topology_type,
  server_descriptions,
  replica_set_name,
  max_set_version,
  max_election_id,
  topology_settings 
)
Representation of a deployment of MongoDB servers.

:Parameters:
  - `topology_type`: initial type
  - `server_descriptions`: dict of (address, ServerDescription) for
    all seeds
  - `replica_set_name`: replica set name or None
  - `max_set_version`: greatest setVersion seen from a primary, or None
  - `max_election_id`: greatest electionId seen from a primary, or None
  - `topology_settings`: a TopologySettings

Member Function Documentation

◆ __repr__()

def __repr__ (   self)

◆ apply_selector()

def apply_selector (   self,
  selector,
  address,
  custom_selector = None 
)

◆ check_compatible()

def check_compatible (   self)
Raise ConfigurationError if any server is incompatible.

A server is incompatible if its wire protocol version range does not
overlap with PyMongo's.

◆ common_wire_version()

def common_wire_version (   self)
Minimum of all servers' max wire versions, or None.

◆ has_known_servers()

def has_known_servers (   self)
Whether there are any Servers of types besides Unknown.

◆ has_readable_server()

def has_readable_server (   self,
  read_preference = ReadPreference.PRIMARY 
)
Does this topology have any readable servers available matching the
given read preference?

:Parameters:
  - `read_preference`: an instance of a read preference from
    :mod:`~pymongo.read_preferences`. Defaults to
    :attr:`~pymongo.read_preferences.ReadPreference.PRIMARY`.

.. note:: When connected directly to a single server this method
  always returns ``True``.

.. versionadded:: 3.4

◆ has_server()

def has_server (   self,
  address 
)

◆ has_writable_server()

def has_writable_server (   self)
Does this topology have a writable server available?

.. note:: When connected directly to a single server this method
  always returns ``True``.

.. versionadded:: 3.4

◆ heartbeat_frequency()

def heartbeat_frequency (   self)

◆ known_servers()

def known_servers (   self)
List of Servers of types besides Unknown.

◆ logical_session_timeout_minutes()

def logical_session_timeout_minutes (   self)
Minimum logical session timeout, or None.

◆ max_election_id()

def max_election_id (   self)
Greatest electionId seen from a primary, or None.

◆ max_set_version()

def max_set_version (   self)
Greatest setVersion seen from a primary, or None.

◆ readable_servers()

def readable_servers (   self)
List of readable Servers.

◆ replica_set_name()

def replica_set_name (   self)
The replica set name.

◆ reset()

def reset (   self)
A copy of this description, with all servers marked Unknown.

◆ reset_server()

def reset_server (   self,
  address 
)
A copy of this description, with one server marked Unknown.

◆ server_descriptions()

def server_descriptions (   self)
Dict of (address,
:class:`~pymongo.server_description.ServerDescription`).

◆ topology_type()

def topology_type (   self)
The type of this topology.

◆ topology_type_name()

def topology_type_name (   self)
The topology type as a human readable string.

.. versionadded:: 3.4

Field Documentation

◆ topology_type

topology_type

The documentation for this class was generated from the following file: