<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>topology_description – An object representation of a deployment of MongoDB servers. — PyMongo 3.7.2 documentation</title>
<link rel="stylesheet" href="../../_static/pydoctheme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/language_data.js"></script>
<script type="text/javascript" src="../../_static/sidebar.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">PyMongo 3.7.2 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-pymongo.topology_description">
<span id="topology-description-an-object-representation-of-a-deployment-of-mongodb-servers"></span><h1><code class="xref py py-mod docutils literal notranslate"><span class="pre">topology_description</span></code> – An object representation of a deployment of MongoDB servers.<a class="headerlink" href="#module-pymongo.topology_description" title="Permalink to this headline">¶</a></h1>
<p>Represent a deployment of MongoDB servers.</p>
<dl class="class">
<dt id="pymongo.topology_description.TopologyDescription">
<em class="property">class </em><code class="descclassname">pymongo.topology_description.</code><code class="descname">TopologyDescription</code><a class="headerlink" href="#pymongo.topology_description.TopologyDescription" title="Permalink to this definition">¶</a></dt>
<dd><p>Representation of a deployment of MongoDB servers.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><cite>topology_type</cite>: initial type</li>
<li><cite>server_descriptions</cite>: dict of (address, ServerDescription) for
all seeds</li>
<li><cite>replica_set_name</cite>: replica set name or None</li>
<li><cite>max_set_version</cite>: greatest setVersion seen from a primary, or None</li>
<li><cite>max_election_id</cite>: greatest electionId seen from a primary, or None</li>
<li><cite>topology_settings</cite>: a TopologySettings</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="pymongo.topology_description.TopologyDescription.has_readable_server">
<code class="descname">has_readable_server</code><span class="sig-paren">(</span><em>read_preference=ReadPreference.PRIMARY</em><span class="sig-paren">)</span><a class="headerlink" href="#pymongo.topology_description.TopologyDescription.has_readable_server" title="Permalink to this definition">¶</a></dt>
<dd><p>Does this topology have any readable servers available matching the
given read preference?</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><cite>read_preference</cite>: an instance of a read preference from
<a class="reference internal" href="read_preferences.html#module-pymongo.read_preferences" title="pymongo.read_preferences: Utilities for choosing which member of a replica set to read from."><code class="xref py py-mod docutils literal notranslate"><span class="pre">read_preferences</span></code></a>. Defaults to
<a class="reference internal" href="read_preferences.html#pymongo.read_preferences.ReadPreference.PRIMARY" title="pymongo.read_preferences.ReadPreference.PRIMARY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PRIMARY</span></code></a>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">When connected directly to a single server this method
always returns <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
</div>
<div class="versionadded">
<p><span class="versionmodified">New in version 3.4.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="pymongo.topology_description.TopologyDescription.has_writable_server">
<code class="descname">has_writable_server</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pymongo.topology_description.TopologyDescription.has_writable_server" title="Permalink to this definition">¶</a></dt>
<dd><p>Does this topology have a writable server available?</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">When connected directly to a single server this method
always returns <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
</div>
<div class="versionadded">
<p><span class="versionmodified">New in version 3.4.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="pymongo.topology_description.TopologyDescription.server_descriptions">
<code class="descname">server_descriptions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pymongo.topology_description.TopologyDescription.server_descriptions" title="Permalink to this definition">¶</a></dt>
<dd><p>Dict of (address,
<a class="reference internal" href="server_description.html#pymongo.server_description.ServerDescription" title="pymongo.server_description.ServerDescription"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServerDescription</span></code></a>).</p>
</dd></dl>
<dl class="attribute">
<dt id="pymongo.topology_description.TopologyDescription.topology_type">
<code class="descname">topology_type</code><a class="headerlink" href="#pymongo.topology_description.TopologyDescription.topology_type" title="Permalink to this definition">¶</a></dt>
<dd><p>The type of this topology.</p>
</dd></dl>
<dl class="attribute">
<dt id="pymongo.topology_description.TopologyDescription.topology_type_name">
<code class="descname">topology_type_name</code><a class="headerlink" href="#pymongo.topology_description.TopologyDescription.topology_type_name" title="Permalink to this definition">¶</a></dt>
<dd><p>The topology type as a human readable string.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 3.4.</span></p>
</div>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/api/pymongo/topology_description.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">PyMongo 3.7.2 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright MongoDB, Inc. 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
bc55833f04f370ac3ed453ef5b0ad686
>
files
>
264
