/usr/share/doc/python-pymongo-doc/html/api/bson/dbref.html is in python-pymongo-doc 2.7.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 | <!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="Content-Type" content="text/html; charset=utf-8" />
<title>dbref – Tools for manipulating DBRefs (references to documents stored in MongoDB) — PyMongo 2.7.2 documentation</title>
<link rel="stylesheet" href="../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '2.7.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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/sidebar.js"></script>
<link rel="top" title="PyMongo 2.7.2 documentation" href="../../index.html" />
<link rel="up" title="bson – BSON (Binary JSON) Encoding and Decoding" href="index.html" />
<link rel="next" title="errors – Exceptions raised by the bson package" href="errors.html" />
<link rel="prev" title="code – Tools for representing JavaScript code" href="code.html" />
</head>
<body>
<div class="related">
<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="errors.html" title="errors – Exceptions raised by the bson package"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="code.html" title="code – Tools for representing JavaScript code"
accesskey="P">previous</a> |</li>
<li><a href="../../index.html">PyMongo 2.7.2 documentation</a> »</li>
<li><a href="../index.html" >API Documentation</a> »</li>
<li><a href="index.html" accesskey="U"><tt class="docutils literal"><span class="pre">bson</span></tt> – BSON (Binary JSON) Encoding and Decoding</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-bson.dbref">
<span id="dbref-tools-for-manipulating-dbrefs-references-to-documents-stored-in-mongodb"></span><h1><tt class="xref py py-mod docutils literal"><span class="pre">dbref</span></tt> – Tools for manipulating DBRefs (references to documents stored in MongoDB)<a class="headerlink" href="#module-bson.dbref" title="Permalink to this headline">¶</a></h1>
<p>Tools for manipulating DBRefs (references to MongoDB documents).</p>
<dl class="class">
<dt id="bson.dbref.DBRef">
<em class="property">class </em><tt class="descclassname">bson.dbref.</tt><tt class="descname">DBRef</tt><big>(</big><em>collection</em>, <em>id</em>, <em>database=None</em>, <em>_extra={}</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#bson.dbref.DBRef" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize a new <a class="reference internal" href="#bson.dbref.DBRef" title="bson.dbref.DBRef"><tt class="xref py py-class docutils literal"><span class="pre">DBRef</span></tt></a>.</p>
<p>Raises <tt class="xref py py-class docutils literal"><span class="pre">TypeError</span></tt> if <cite>collection</cite> or <cite>database</cite> is not
an instance of <tt class="xref py py-class docutils literal"><span class="pre">basestring</span></tt> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> in python 3).
<cite>database</cite> is optional and allows references to documents to work
across databases. Any additional keyword arguments will create
additional fields in the resultant embedded document.</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>collection</cite>: name of the collection the document is stored in</li>
<li><cite>id</cite>: the value of the document’s <tt class="docutils literal"><span class="pre">"_id"</span></tt> field</li>
<li><cite>database</cite> (optional): name of the database to reference</li>
<li><cite>**kwargs</cite> (optional): additional keyword arguments will
create additional, custom fields</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.8: </span>Now takes keyword arguments to specify additional fields.</p>
</div>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.1: </span>The <cite>database</cite> parameter.</p>
</div>
<div class="admonition-see-general-mongodb-documentation admonition seealso">
<p class="first admonition-title">See also</p>
<p class="admonition-title">See general MongoDB documentation</p>
<p class="last"><a class="reference external" href="http://dochub.mongodb.org/core/dbrefs" name="bson.dbref.DBRef"><em>dbrefs</em></a></p>
</div>
<dl class="method">
<dt id="bson.dbref.DBRef.as_doc">
<tt class="descname">as_doc</tt><big>(</big><big>)</big><a class="headerlink" href="#bson.dbref.DBRef.as_doc" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the SON document representation of this DBRef.</p>
<p>Generally not needed by application developers</p>
</dd></dl>
<dl class="attribute">
<dt id="bson.dbref.DBRef.collection">
<tt class="descname">collection</tt><a class="headerlink" href="#bson.dbref.DBRef.collection" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the name of this DBRef’s collection as unicode.</p>
</dd></dl>
<dl class="attribute">
<dt id="bson.dbref.DBRef.database">
<tt class="descname">database</tt><a class="headerlink" href="#bson.dbref.DBRef.database" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the name of this DBRef’s database.</p>
<p>Returns None if this DBRef doesn’t specify a database.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.1.</span></p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="bson.dbref.DBRef.id">
<tt class="descname">id</tt><a class="headerlink" href="#bson.dbref.DBRef.id" title="Permalink to this definition">¶</a></dt>
<dd><p>Get this DBRef’s _id.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="code.html"
title="previous chapter"><tt class="docutils literal"><span class="pre">code</span></tt> – Tools for representing JavaScript code</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="errors.html"
title="next chapter"><tt class="docutils literal"><span class="pre">errors</span></tt> – Exceptions raised by the <tt class="docutils literal"><span class="pre">bson</span></tt> package</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/api/bson/dbref.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<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>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<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="errors.html" title="errors – Exceptions raised by the bson package"
>next</a> |</li>
<li class="right" >
<a href="code.html" title="code – Tools for representing JavaScript code"
>previous</a> |</li>
<li><a href="../../index.html">PyMongo 2.7.2 documentation</a> »</li>
<li><a href="../index.html" >API Documentation</a> »</li>
<li><a href="index.html" ><tt class="docutils literal"><span class="pre">bson</span></tt> – BSON (Binary JSON) Encoding and Decoding</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2008 - 2014, MongoDB, Inc..
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>
|