/usr/share/doc/python-pymongo-doc/html/api/gridfs/index.html is in python-pymongo-doc 2.6.3-1build1.
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 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 | <!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>gridfs – Tools for working with GridFS — PyMongo 2.6.3 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.6.3',
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.6.3 documentation" href="../../index.html" />
<link rel="up" title="API Documentation" href="../index.html" />
<link rel="next" title="errors – Exceptions raised by the gridfs package" href="errors.html" />
<link rel="prev" title="uri_parser – Tools to parse and validate a MongoDB URI" href="../pymongo/uri_parser.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 gridfs package"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../pymongo/uri_parser.html" title="uri_parser – Tools to parse and validate a MongoDB URI"
accesskey="P">previous</a> |</li>
<li><a href="../../index.html">PyMongo 2.6.3 documentation</a> »</li>
<li><a href="../index.html" accesskey="U">API Documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-gridfs">
<span id="gridfs-tools-for-working-with-gridfs"></span><h1><a class="reference internal" href="#module-gridfs" title="gridfs: Tools for working with GridFS"><tt class="xref py py-mod docutils literal"><span class="pre">gridfs</span></tt></a> – Tools for working with GridFS<a class="headerlink" href="#module-gridfs" title="Permalink to this headline">¶</a></h1>
<p>GridFS is a specification for storing large objects in Mongo.</p>
<p>The <a class="reference internal" href="#module-gridfs" title="gridfs: Tools for working with GridFS"><tt class="xref py py-mod docutils literal"><span class="pre">gridfs</span></tt></a> package is an implementation of GridFS on top of
<a class="reference internal" href="../pymongo/index.html#module-pymongo" title="pymongo: Python driver for MongoDB"><tt class="xref py py-mod docutils literal"><span class="pre">pymongo</span></tt></a>, exposing a file-like interface.</p>
<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/gridfs" name="gridfs.GridFS"><em>gridfs</em></a></p>
</div>
<dl class="class">
<dt id="gridfs.GridFS">
<em class="property">class </em><tt class="descclassname">gridfs.</tt><tt class="descname">GridFS</tt><big>(</big><em>database</em>, <em>collection='fs'</em><big>)</big><a class="headerlink" href="#gridfs.GridFS" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new instance of <a class="reference internal" href="#gridfs.GridFS" title="gridfs.GridFS"><tt class="xref py py-class docutils literal"><span class="pre">GridFS</span></tt></a>.</p>
<p>Raises <tt class="xref py py-class docutils literal"><span class="pre">TypeError</span></tt> if <cite>database</cite> is not an instance of
<a class="reference internal" href="../pymongo/database.html#pymongo.database.Database" title="pymongo.database.Database"><tt class="xref py py-class docutils literal"><span class="pre">Database</span></tt></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>database</cite>: database to use</li>
<li><cite>collection</cite> (optional): root collection to use</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.6: </span>The <cite>collection</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/gridfs" name="gridfs.GridFS"><em>gridfs</em></a></p>
</div>
<dl class="method">
<dt id="gridfs.GridFS.delete">
<tt class="descname">delete</tt><big>(</big><em>file_id</em><big>)</big><a class="headerlink" href="#gridfs.GridFS.delete" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a file from GridFS by <tt class="docutils literal"><span class="pre">"_id"</span></tt>.</p>
<p>Removes all data belonging to the file with <tt class="docutils literal"><span class="pre">"_id"</span></tt>:
<cite>file_id</cite>.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Any processes/threads reading from the file while
this method is executing will likely see an invalid/corrupt
file. Care should be taken to avoid concurrent reads to a file
while it is being deleted.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Deletes of non-existent files are considered successful
since the end result is the same: no file with that _id remains.</p>
</div>
<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>file_id</cite>: <tt class="docutils literal"><span class="pre">"_id"</span></tt> of the file to delete</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.6.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="gridfs.GridFS.exists">
<tt class="descname">exists</tt><big>(</big><em>document_or_id=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#gridfs.GridFS.exists" title="Permalink to this definition">¶</a></dt>
<dd><p>Check if a file exists in this instance of <a class="reference internal" href="#gridfs.GridFS" title="gridfs.GridFS"><tt class="xref py py-class docutils literal"><span class="pre">GridFS</span></tt></a>.</p>
<p>The file to check for can be specified by the value of its
<tt class="docutils literal"><span class="pre">_id</span></tt> key, or by passing in a query document. A query
document can be passed in as dictionary, or by using keyword
arguments. Thus, the following three calls are equivalent:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">fs</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">file_id</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">fs</span><span class="o">.</span><span class="n">exists</span><span class="p">({</span><span class="s">"_id"</span><span class="p">:</span> <span class="n">file_id</span><span class="p">})</span>
<span class="gp">>>> </span><span class="n">fs</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">_id</span><span class="o">=</span><span class="n">file_id</span><span class="p">)</span>
</pre></div>
</div>
<p>As are the following two calls:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">fs</span><span class="o">.</span><span class="n">exists</span><span class="p">({</span><span class="s">"filename"</span><span class="p">:</span> <span class="s">"mike.txt"</span><span class="p">})</span>
<span class="gp">>>> </span><span class="n">fs</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">filename</span><span class="o">=</span><span class="s">"mike.txt"</span><span class="p">)</span>
</pre></div>
</div>
<p>And the following two:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">fs</span><span class="o">.</span><span class="n">exists</span><span class="p">({</span><span class="s">"foo"</span><span class="p">:</span> <span class="p">{</span><span class="s">"$gt"</span><span class="p">:</span> <span class="mi">12</span><span class="p">}})</span>
<span class="gp">>>> </span><span class="n">fs</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">foo</span><span class="o">=</span><span class="p">{</span><span class="s">"$gt"</span><span class="p">:</span> <span class="mi">12</span><span class="p">})</span>
</pre></div>
</div>
<p>Returns <tt class="docutils literal"><span class="pre">True</span></tt> if a matching file exists, <tt class="docutils literal"><span class="pre">False</span></tt>
otherwise. Calls to <a class="reference internal" href="#gridfs.GridFS.exists" title="gridfs.GridFS.exists"><tt class="xref py py-meth docutils literal"><span class="pre">exists()</span></tt></a> will not automatically
create appropriate indexes; application developers should be
sure to create indexes if needed and as appropriate.</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>document_or_id</cite> (optional): query document, or _id of the
document to check for</li>
<li><cite>**kwargs</cite> (optional): keyword arguments are used as a
query document, if they’re present.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.8.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="gridfs.GridFS.get">
<tt class="descname">get</tt><big>(</big><em>file_id</em><big>)</big><a class="headerlink" href="#gridfs.GridFS.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a file from GridFS by <tt class="docutils literal"><span class="pre">"_id"</span></tt>.</p>
<p>Returns an instance of <a class="reference internal" href="grid_file.html#gridfs.grid_file.GridOut" title="gridfs.grid_file.GridOut"><tt class="xref py py-class docutils literal"><span class="pre">GridOut</span></tt></a>,
which provides a file-like interface for reading.</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>file_id</cite>: <tt class="docutils literal"><span class="pre">"_id"</span></tt> of the file to get</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.6.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="gridfs.GridFS.get_last_version">
<tt class="descname">get_last_version</tt><big>(</big><em>filename=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#gridfs.GridFS.get_last_version" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the most recent version of a file in GridFS by <tt class="docutils literal"><span class="pre">"filename"</span></tt>
or metadata fields.</p>
<p>Equivalent to calling <a class="reference internal" href="#gridfs.GridFS.get_version" title="gridfs.GridFS.get_version"><tt class="xref py py-meth docutils literal"><span class="pre">get_version()</span></tt></a> with the default
<cite>version</cite> (<tt class="docutils literal"><span class="pre">-1</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>filename</cite>: <tt class="docutils literal"><span class="pre">"filename"</span></tt> of the file to get, or <cite>None</cite></li>
<li><cite>**kwargs</cite> (optional): find files by custom metadata.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.11: </span><cite>filename</cite> defaults to None;</p>
</div>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.11: </span>Accept keyword arguments to find files by custom metadata. See
<a class="reference internal" href="#gridfs.GridFS.get_version" title="gridfs.GridFS.get_version"><tt class="xref py py-meth docutils literal"><span class="pre">get_version()</span></tt></a>.</p>
</div>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.6.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="gridfs.GridFS.get_version">
<tt class="descname">get_version</tt><big>(</big><em>filename=None</em>, <em>version=-1</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#gridfs.GridFS.get_version" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a file from GridFS by <tt class="docutils literal"><span class="pre">"filename"</span></tt> or metadata fields.</p>
<p>Returns a version of the file in GridFS whose filename matches
<cite>filename</cite> and whose metadata fields match the supplied keyword
arguments, as an instance of <a class="reference internal" href="grid_file.html#gridfs.grid_file.GridOut" title="gridfs.grid_file.GridOut"><tt class="xref py py-class docutils literal"><span class="pre">GridOut</span></tt></a>.</p>
<p>Version numbering is a convenience atop the GridFS API provided
by MongoDB. If more than one file matches the query (either by
<cite>filename</cite> alone, by metadata fields, or by a combination of
both), then version <tt class="docutils literal"><span class="pre">-1</span></tt> will be the most recently uploaded
matching file, <tt class="docutils literal"><span class="pre">-2</span></tt> the second most recently
uploaded, etc. Version <tt class="docutils literal"><span class="pre">0</span></tt> will be the first version
uploaded, <tt class="docutils literal"><span class="pre">1</span></tt> the second version, etc. So if three versions
have been uploaded, then version <tt class="docutils literal"><span class="pre">0</span></tt> is the same as version
<tt class="docutils literal"><span class="pre">-3</span></tt>, version <tt class="docutils literal"><span class="pre">1</span></tt> is the same as version <tt class="docutils literal"><span class="pre">-2</span></tt>, and
version <tt class="docutils literal"><span class="pre">2</span></tt> is the same as version <tt class="docutils literal"><span class="pre">-1</span></tt>.</p>
<p>Raises <a class="reference internal" href="errors.html#gridfs.errors.NoFile" title="gridfs.errors.NoFile"><tt class="xref py py-class docutils literal"><span class="pre">NoFile</span></tt></a> if no such version of
that file exists.</p>
<p>An index on <tt class="docutils literal"><span class="pre">{filename:</span> <span class="pre">1,</span> <span class="pre">uploadDate:</span> <span class="pre">-1}</span></tt> will
automatically be created when this method is called the first
time.</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>filename</cite>: <tt class="docutils literal"><span class="pre">"filename"</span></tt> of the file to get, or <cite>None</cite></li>
<li><cite>version</cite> (optional): version of the file to get (defaults
to -1, the most recent version uploaded)</li>
<li><cite>**kwargs</cite> (optional): find files by custom metadata.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.11: </span><cite>filename</cite> defaults to None;</p>
</div>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.11: </span>Accept keyword arguments to find files by custom metadata.</p>
</div>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.9.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="gridfs.GridFS.list">
<tt class="descname">list</tt><big>(</big><big>)</big><a class="headerlink" href="#gridfs.GridFS.list" title="Permalink to this definition">¶</a></dt>
<dd><p>List the names of all files stored in this instance of
<a class="reference internal" href="#gridfs.GridFS" title="gridfs.GridFS"><tt class="xref py py-class docutils literal"><span class="pre">GridFS</span></tt></a>.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.6: </span>Removed the <cite>collection</cite> argument.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="gridfs.GridFS.new_file">
<tt class="descname">new_file</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#gridfs.GridFS.new_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new file in GridFS.</p>
<p>Returns a new <a class="reference internal" href="grid_file.html#gridfs.grid_file.GridIn" title="gridfs.grid_file.GridIn"><tt class="xref py py-class docutils literal"><span class="pre">GridIn</span></tt></a> instance to
which data can be written. Any keyword arguments will be
passed through to <a class="reference internal" href="grid_file.html#gridfs.grid_file.GridIn" title="gridfs.grid_file.GridIn"><tt class="xref py py-meth docutils literal"><span class="pre">GridIn()</span></tt></a>.</p>
<p>If the <tt class="docutils literal"><span class="pre">"_id"</span></tt> of the file is manually specified, it must
not already exist in GridFS. Otherwise
<a class="reference internal" href="errors.html#gridfs.errors.FileExists" title="gridfs.errors.FileExists"><tt class="xref py py-class docutils literal"><span class="pre">FileExists</span></tt></a> is raised.</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>**kwargs</cite> (optional): keyword arguments for file creation</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.6.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="gridfs.GridFS.open">
<tt class="descname">open</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#gridfs.GridFS.open" title="Permalink to this definition">¶</a></dt>
<dd><p>No longer supported.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.6: </span>The open method is no longer supported.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="gridfs.GridFS.put">
<tt class="descname">put</tt><big>(</big><em>data</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#gridfs.GridFS.put" title="Permalink to this definition">¶</a></dt>
<dd><p>Put data in GridFS as a new file.</p>
<p>Equivalent to doing:</p>
<div class="highlight-python"><pre>try:
f = new_file(**kwargs)
f.write(data)
finally
f.close()</pre>
</div>
<p><cite>data</cite> can be either an instance of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> (<tt class="xref py py-class docutils literal"><span class="pre">bytes</span></tt>
in python 3) or a file-like object providing a <tt class="xref py py-meth docutils literal"><span class="pre">read()</span></tt> method.
If an <cite>encoding</cite> keyword argument is passed, <cite>data</cite> can also be a
<tt class="xref py py-class docutils literal"><span class="pre">unicode</span></tt> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> in python 3) instance, which will
be encoded as <cite>encoding</cite> before being written. Any keyword arguments
will be passed through to the created file - see
<a class="reference internal" href="grid_file.html#gridfs.grid_file.GridIn" title="gridfs.grid_file.GridIn"><tt class="xref py py-meth docutils literal"><span class="pre">GridIn()</span></tt></a> for possible arguments. Returns the
<tt class="docutils literal"><span class="pre">"_id"</span></tt> of the created file.</p>
<p>If the <tt class="docutils literal"><span class="pre">"_id"</span></tt> of the file is manually specified, it must
not already exist in GridFS. Otherwise
<a class="reference internal" href="errors.html#gridfs.errors.FileExists" title="gridfs.errors.FileExists"><tt class="xref py py-class docutils literal"><span class="pre">FileExists</span></tt></a> is raised.</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>data</cite>: data to be written as a file.</li>
<li><cite>**kwargs</cite> (optional): keyword arguments for file creation</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.9: </span>The ability to write <tt class="xref py py-class docutils literal"><span class="pre">unicode</span></tt>, if an <cite>encoding</cite> has
been specified as a keyword argument.</p>
</div>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.6.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="gridfs.GridFS.remove">
<tt class="descname">remove</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#gridfs.GridFS.remove" title="Permalink to this definition">¶</a></dt>
<dd><p>No longer supported.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.6: </span>The remove method is no longer supported.</p>
</div>
</dd></dl>
</dd></dl>
<p>Sub-modules:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="errors.html"><tt class="docutils literal"><span class="pre">errors</span></tt> – Exceptions raised by the <tt class="docutils literal"><span class="pre">gridfs</span></tt> package</a></li>
<li class="toctree-l1"><a class="reference internal" href="grid_file.html"><tt class="docutils literal"><span class="pre">grid_file</span></tt> – Tools for representing files stored in GridFS</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="../pymongo/uri_parser.html"
title="previous chapter"><tt class="docutils literal"><span class="pre">uri_parser</span></tt> – Tools to parse and validate a MongoDB URI</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">gridfs</span></tt> package</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/api/gridfs/index.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 gridfs package"
>next</a> |</li>
<li class="right" >
<a href="../pymongo/uri_parser.html" title="uri_parser – Tools to parse and validate a MongoDB URI"
>previous</a> |</li>
<li><a href="../../index.html">PyMongo 2.6.3 documentation</a> »</li>
<li><a href="../index.html" >API Documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2008 - 2012, 10gen, Inc..
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.
</div>
</body>
</html>
|