/usr/share/doc/python-pymongo-doc/html/api/pymongo/command_cursor.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 | <!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>command_cursor – Tools for iterating over MongoDB command results — 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="pymongo – Python driver for MongoDB" href="index.html" />
<link rel="next" title="cursor – Tools for iterating over MongoDB query results" href="cursor.html" />
<link rel="prev" title="collection – Collection level operations" href="collection.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="cursor.html" title="cursor – Tools for iterating over MongoDB query results"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="collection.html" title="collection – Collection level operations"
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">pymongo</span></tt> – Python driver for MongoDB</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-pymongo.command_cursor">
<span id="command-cursor-tools-for-iterating-over-mongodb-command-results"></span><h1><tt class="xref py py-mod docutils literal"><span class="pre">command_cursor</span></tt> – Tools for iterating over MongoDB command results<a class="headerlink" href="#module-pymongo.command_cursor" title="Permalink to this headline">¶</a></h1>
<p>CommandCursor class to iterate over command results.</p>
<dl class="class">
<dt id="pymongo.command_cursor.CommandCursor">
<em class="property">class </em><tt class="descclassname">pymongo.command_cursor.</tt><tt class="descname">CommandCursor</tt><big>(</big><em>collection</em>, <em>cursor_info</em>, <em>conn_id</em>, <em>compile_re=True</em>, <em>retrieved=0</em><big>)</big><a class="headerlink" href="#pymongo.command_cursor.CommandCursor" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new command cursor.</p>
<dl class="attribute">
<dt id="pymongo.command_cursor.CommandCursor.alive">
<tt class="descname">alive</tt><a class="headerlink" href="#pymongo.command_cursor.CommandCursor.alive" title="Permalink to this definition">¶</a></dt>
<dd><p>Does this cursor have the potential to return more data?</p>
</dd></dl>
<dl class="method">
<dt id="pymongo.command_cursor.CommandCursor.batch_size">
<tt class="descname">batch_size</tt><big>(</big><em>batch_size</em><big>)</big><a class="headerlink" href="#pymongo.command_cursor.CommandCursor.batch_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Limits the number of documents returned in one batch. Each batch
requires a round trip to the server. It can be adjusted to optimize
performance and limit data transfer.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">batch_size can not override MongoDB’s internal limits on the
amount of data it will return to the client in a single batch (i.e
if you set batch size to 1,000,000,000, MongoDB will currently only
return 4-16MB of results per batch).</p>
</div>
<p>Raises <tt class="xref py py-exc docutils literal"><span class="pre">TypeError</span></tt> if <cite>batch_size</cite> is not an integer.
Raises <tt class="xref py py-exc docutils literal"><span class="pre">ValueError</span></tt> if <cite>batch_size</cite> is less than <tt class="docutils literal"><span class="pre">0</span></tt>.</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>batch_size</cite>: The size of each batch of results requested.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pymongo.command_cursor.CommandCursor.close">
<tt class="descname">close</tt><big>(</big><big>)</big><a class="headerlink" href="#pymongo.command_cursor.CommandCursor.close" title="Permalink to this definition">¶</a></dt>
<dd><p>Explicitly close / kill this cursor. Required for PyPy, Jython and
other Python implementations that don’t use reference counting
garbage collection.</p>
</dd></dl>
<dl class="attribute">
<dt id="pymongo.command_cursor.CommandCursor.cursor_id">
<tt class="descname">cursor_id</tt><a class="headerlink" href="#pymongo.command_cursor.CommandCursor.cursor_id" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the id of the cursor.</p>
</dd></dl>
<dl class="method">
<dt id="pymongo.command_cursor.CommandCursor.next">
<tt class="descname">next</tt><big>(</big><big>)</big><a class="headerlink" href="#pymongo.command_cursor.CommandCursor.next" title="Permalink to this definition">¶</a></dt>
<dd><p>Advance the cursor.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="collection.html"
title="previous chapter"><tt class="docutils literal"><span class="pre">collection</span></tt> – Collection level operations</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="cursor.html"
title="next chapter"><tt class="docutils literal"><span class="pre">cursor</span></tt> – Tools for iterating over MongoDB query results</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/api/pymongo/command_cursor.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="cursor.html" title="cursor – Tools for iterating over MongoDB query results"
>next</a> |</li>
<li class="right" >
<a href="collection.html" title="collection – Collection level operations"
>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">pymongo</span></tt> – Python driver for MongoDB</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>
|