<!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>raw_bson – Tools for representing raw BSON documents. — 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="regex – Tools for representing MongoDB regular expressions" href="regex.html" /> <link rel="prev" title="objectid – Tools for working with MongoDB ObjectIds" href="objectid.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="regex.html" title="regex – Tools for representing MongoDB regular expressions" accesskey="N">next</a> |</li> <li class="right" > <a href="objectid.html" title="objectid – Tools for working with MongoDB ObjectIds" 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">bson</span></code> – BSON (Binary JSON) Encoding and Decoding</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="module-bson.raw_bson"> <span id="raw-bson-tools-for-representing-raw-bson-documents"></span><h1><code class="xref py py-mod docutils literal notranslate"><span class="pre">raw_bson</span></code> – Tools for representing raw BSON documents.<a class="headerlink" href="#module-bson.raw_bson" title="Permalink to this headline">¶</a></h1> <p>Tools for representing raw BSON documents.</p> <dl class="class"> <dt id="bson.raw_bson.RawBSONDocument"> <em class="property">class </em><code class="descclassname">bson.raw_bson.</code><code class="descname">RawBSONDocument</code><span class="sig-paren">(</span><em>bson_bytes</em>, <em>codec_options=None</em><span class="sig-paren">)</span><a class="headerlink" href="#bson.raw_bson.RawBSONDocument" title="Permalink to this definition">¶</a></dt> <dd><p>Create a new <a class="reference internal" href="#bson.raw_bson.RawBSONDocument" title="bson.raw_bson.RawBSONDocument"><code class="xref py py-class docutils literal notranslate"><span class="pre">RawBSONDocument</span></code></a>.</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>bson_bytes</cite>: the BSON bytes that compose this document</li> <li><cite>codec_options</cite> (optional): An instance of <a class="reference internal" href="codec_options.html#bson.codec_options.CodecOptions" title="bson.codec_options.CodecOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">CodecOptions</span></code></a>.</li> </ul> </td> </tr> </tbody> </table> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 3.5: </span>If a <a class="reference internal" href="codec_options.html#bson.codec_options.CodecOptions" title="bson.codec_options.CodecOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">CodecOptions</span></code></a> is passed in, its <cite>document_class</cite> must be <a class="reference internal" href="#bson.raw_bson.RawBSONDocument" title="bson.raw_bson.RawBSONDocument"><code class="xref py py-class docutils literal notranslate"><span class="pre">RawBSONDocument</span></code></a>.</p> </div> <dl class="method"> <dt id="bson.raw_bson.RawBSONDocument.items"> <code class="descname">items</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bson.raw_bson.RawBSONDocument.items" title="Permalink to this definition">¶</a></dt> <dd><p>Lazily decode and iterate elements in this document.</p> </dd></dl> <dl class="attribute"> <dt id="bson.raw_bson.RawBSONDocument.raw"> <code class="descname">raw</code><a class="headerlink" href="#bson.raw_bson.RawBSONDocument.raw" title="Permalink to this definition">¶</a></dt> <dd><p>The raw BSON bytes composing this document.</p> </dd></dl> </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="objectid.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">objectid</span></code> – Tools for working with MongoDB ObjectIds</a></p> <h4>Next topic</h4> <p class="topless"><a href="regex.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">regex</span></code> – Tools for representing MongoDB regular expressions</a></p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../../_sources/api/bson/raw_bson.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="regex.html" title="regex – Tools for representing MongoDB regular expressions" >next</a> |</li> <li class="right" > <a href="objectid.html" title="objectid – Tools for working with MongoDB ObjectIds" >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">bson</span></code> – BSON (Binary JSON) Encoding and Decoding</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>