<!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>PyMongo 3.7.2 Documentation — 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" /> <link rel="next" title="Using PyMongo with MongoDB Atlas" href="atlas.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="right" > <a href="atlas.html" title="Using PyMongo with MongoDB Atlas" accesskey="N">next</a> |</li> <li class="nav-item nav-item-0"><a href="#">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="pymongo-release-documentation"> <h1>PyMongo 3.7.2 Documentation<a class="headerlink" href="#pymongo-release-documentation" title="Permalink to this headline">¶</a></h1> <div class="section" id="overview"> <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2> <p><strong>PyMongo</strong> is a Python distribution containing tools for working with <a class="reference external" href="http://www.mongodb.org">MongoDB</a>, and is the recommended way to work with MongoDB from Python. This documentation attempts to explain everything you need to know to use <strong>PyMongo</strong>.</p> <dl class="docutils"> <dt><a class="reference internal" href="installation.html"><span class="doc">Installing / Upgrading</span></a></dt> <dd>Instructions on how to get the distribution.</dd> <dt><a class="reference internal" href="tutorial.html"><span class="doc">Tutorial</span></a></dt> <dd>Start here for a quick overview.</dd> <dt><a class="reference internal" href="examples/index.html"><span class="doc">Examples</span></a></dt> <dd>Examples of how to perform specific tasks.</dd> <dt><a class="reference internal" href="atlas.html"><span class="doc">Using PyMongo with MongoDB Atlas</span></a></dt> <dd>Using PyMongo with MongoDB Atlas.</dd> <dt><a class="reference internal" href="examples/tls.html"><span class="doc">TLS/SSL and PyMongo</span></a></dt> <dd>Using PyMongo with TLS / SSL.</dd> <dt><a class="reference internal" href="faq.html"><span class="doc">Frequently Asked Questions</span></a></dt> <dd>Some questions that come up often.</dd> <dt><a class="reference internal" href="migrate-to-pymongo3.html"><span class="doc">PyMongo 3 Migration Guide</span></a></dt> <dd>A PyMongo 2.x to 3.x migration guide.</dd> <dt><a class="reference internal" href="python3.html"><span class="doc">Python 3 FAQ</span></a></dt> <dd>Frequently asked questions about python 3 support.</dd> <dt><a class="reference internal" href="compatibility-policy.html"><span class="doc">Compatibility Policy</span></a></dt> <dd>Explanation of deprecations, and how to keep pace with changes in PyMongo’s API.</dd> <dt><a class="reference internal" href="api/index.html"><span class="doc">API Documentation</span></a></dt> <dd>The complete API documentation, organized by module.</dd> <dt><a class="reference internal" href="tools.html"><span class="doc">Tools</span></a></dt> <dd>A listing of Python tools and libraries that have been written for MongoDB.</dd> <dt><a class="reference internal" href="developer/index.html"><span class="doc">Developer Guide</span></a></dt> <dd>Developer guide for contributors to PyMongo.</dd> </dl> </div> <div class="section" id="getting-help"> <h2>Getting Help<a class="headerlink" href="#getting-help" title="Permalink to this headline">¶</a></h2> <p>If you’re having trouble or have questions about PyMongo, the best place to ask is the <a class="reference external" href="http://groups.google.com/group/mongodb-user">MongoDB user group</a>. Once you get an answer, it’d be great if you could work it back into this documentation and contribute!</p> </div> <div class="section" id="issues"> <h2>Issues<a class="headerlink" href="#issues" title="Permalink to this headline">¶</a></h2> <p>All issues should be reported (and can be tracked / voted for / commented on) at the main <a class="reference external" href="http://jira.mongodb.org/browse/PYTHON">MongoDB JIRA bug tracker</a>, in the “Python Driver” project.</p> </div> <div class="section" id="contributing"> <h2>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h2> <p><strong>PyMongo</strong> has a large <a class="reference internal" href="contributors.html"><span class="doc">community</span></a> and contributions are always encouraged. Contributions can be as simple as minor tweaks to this documentation. To contribute, fork the project on <a class="reference external" href="http://github.com/mongodb/mongo-python-driver/">GitHub</a> and send a pull request.</p> </div> <div class="section" id="changes"> <h2>Changes<a class="headerlink" href="#changes" title="Permalink to this headline">¶</a></h2> <p>See the <a class="reference internal" href="changelog.html"><span class="doc">Changelog</span></a> for a full list of changes to PyMongo. For older versions of the documentation please see the <a class="reference external" href="http://api.mongodb.org/python/">archive list</a>.</p> </div> <div class="section" id="about-this-documentation"> <h2>About This Documentation<a class="headerlink" href="#about-this-documentation" title="Permalink to this headline">¶</a></h2> <p>This documentation is generated using the <a class="reference external" href="http://sphinx.pocoo.org/">Sphinx</a> documentation generator. The source files for the documentation are located in the <em>doc/</em> directory of the <strong>PyMongo</strong> distribution. To generate the docs locally run the following command from the root directory of the <strong>PyMongo</strong> source:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ python setup.py doc </pre></div> </div> </div> <div class="section" id="indices-and-tables"> <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2> <ul class="simple"> <li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li> <li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li> <li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li> </ul> <div class="toctree-wrapper compound"> </div> </div> </div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h3><a href="#">Table of Contents</a></h3> <ul> <li><a class="reference internal" href="#">PyMongo 3.7.2 Documentation</a><ul> <li><a class="reference internal" href="#overview">Overview</a></li> <li><a class="reference internal" href="#getting-help">Getting Help</a></li> <li><a class="reference internal" href="#issues">Issues</a></li> <li><a class="reference internal" href="#contributing">Contributing</a></li> <li><a class="reference internal" href="#changes">Changes</a></li> <li><a class="reference internal" href="#about-this-documentation">About This Documentation</a></li> <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li> </ul> </li> </ul> <h4>Next topic</h4> <p class="topless"><a href="atlas.html" title="next chapter">Using PyMongo with MongoDB Atlas</a></p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="_sources/index.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="right" > <a href="atlas.html" title="Using PyMongo with MongoDB Atlas" >next</a> |</li> <li class="nav-item nav-item-0"><a href="#">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>