<!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>message – Tools for creating messages to be sent to MongoDB — 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="mongo_client – Tools for connecting to MongoDB" href="mongo_client.html" /> <link rel="prev" title="errors – Exceptions raised by the pymongo package" href="errors.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="mongo_client.html" title="mongo_client – Tools for connecting to MongoDB" accesskey="N">next</a> |</li> <li class="right" > <a href="errors.html" title="errors – Exceptions raised by the pymongo package" accesskey="P">previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">PyMongo 3.7.2 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../index.html" >API Documentation</a> »</li> <li class="nav-item nav-item-2"><a href="index.html" accesskey="U"><code class="docutils literal notranslate"><span class="pre">pymongo</span></code> – Python driver for MongoDB</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="module-pymongo.message"> <span id="message-tools-for-creating-messages-to-be-sent-to-mongodb"></span><h1><code class="xref py py-mod docutils literal notranslate"><span class="pre">message</span></code> – Tools for creating messages to be sent to MongoDB<a class="headerlink" href="#module-pymongo.message" title="Permalink to this headline">¶</a></h1> <p>Tools for creating <a class="reference external" href="http://www.mongodb.org/display/DOCS/Mongo+Wire+Protocol">messages</a> to be sent to MongoDB.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">This module is for internal use and is generally not needed by application developers.</p> </div> <dl class="function"> <dt id="pymongo.message.delete"> <code class="descclassname">pymongo.message.</code><code class="descname">delete</code><span class="sig-paren">(</span><em>collection_name</em>, <em>spec</em>, <em>safe</em>, <em>last_error_args</em>, <em>opts</em>, <em>flags=0</em>, <em>ctx=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pymongo.message.delete" title="Permalink to this definition">¶</a></dt> <dd><p>Get a <strong>delete</strong> message.</p> <p><cite>opts</cite> is a CodecOptions. <cite>flags</cite> is a bit vector that may contain the SingleRemove flag or not:</p> <p><a class="reference external" href="http://docs.mongodb.org/meta-driver/latest/legacy/mongodb-wire-protocol/#op-delete">http://docs.mongodb.org/meta-driver/latest/legacy/mongodb-wire-protocol/#op-delete</a></p> </dd></dl> <dl class="function"> <dt id="pymongo.message.get_more"> <code class="descclassname">pymongo.message.</code><code class="descname">get_more</code><span class="sig-paren">(</span><em>collection_name</em>, <em>num_to_return</em>, <em>cursor_id</em>, <em>ctx=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pymongo.message.get_more" title="Permalink to this definition">¶</a></dt> <dd><p>Get a <strong>getMore</strong> message.</p> </dd></dl> <dl class="function"> <dt id="pymongo.message.insert"> <code class="descclassname">pymongo.message.</code><code class="descname">insert</code><span class="sig-paren">(</span><em>collection_name</em>, <em>docs</em>, <em>check_keys</em>, <em>safe</em>, <em>last_error_args</em>, <em>continue_on_error</em>, <em>opts</em>, <em>ctx=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pymongo.message.insert" title="Permalink to this definition">¶</a></dt> <dd><p>Get an <strong>insert</strong> message.</p> </dd></dl> <dl class="function"> <dt id="pymongo.message.kill_cursors"> <code class="descclassname">pymongo.message.</code><code class="descname">kill_cursors</code><span class="sig-paren">(</span><em>cursor_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#pymongo.message.kill_cursors" title="Permalink to this definition">¶</a></dt> <dd><p>Get a <strong>killCursors</strong> message.</p> </dd></dl> <dl class="function"> <dt id="pymongo.message.query"> <code class="descclassname">pymongo.message.</code><code class="descname">query</code><span class="sig-paren">(</span><em>options</em>, <em>collection_name</em>, <em>num_to_skip</em>, <em>num_to_return</em>, <em>query</em>, <em>field_selector</em>, <em>opts</em>, <em>check_keys=False</em>, <em>ctx=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pymongo.message.query" title="Permalink to this definition">¶</a></dt> <dd><p>Get a <strong>query</strong> message.</p> </dd></dl> <dl class="function"> <dt id="pymongo.message.update"> <code class="descclassname">pymongo.message.</code><code class="descname">update</code><span class="sig-paren">(</span><em>collection_name</em>, <em>upsert</em>, <em>multi</em>, <em>spec</em>, <em>doc</em>, <em>safe</em>, <em>last_error_args</em>, <em>check_keys</em>, <em>opts</em>, <em>ctx=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pymongo.message.update" title="Permalink to this definition">¶</a></dt> <dd><p>Get an <strong>update</strong> message.</p> </dd></dl> </div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h4>Previous topic</h4> <p class="topless"><a href="errors.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">errors</span></code> – Exceptions raised by the <code class="docutils literal notranslate"><span class="pre">pymongo</span></code> package</a></p> <h4>Next topic</h4> <p class="topless"><a href="mongo_client.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">mongo_client</span></code> – Tools for connecting to MongoDB</a></p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../../_sources/api/pymongo/message.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="mongo_client.html" title="mongo_client – Tools for connecting to MongoDB" >next</a> |</li> <li class="right" > <a href="errors.html" title="errors – Exceptions raised by the pymongo package" >previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">PyMongo 3.7.2 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../index.html" >API Documentation</a> »</li> <li class="nav-item nav-item-2"><a href="index.html" ><code class="docutils literal notranslate"><span class="pre">pymongo</span></code> – Python driver for MongoDB</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>