python-pymongo-doc 2.7.2-1 / usr / share / doc / python-pymongo-doc / html / api / pymongo / bulk.html

This file is indexed.

/usr/share/doc/python-pymongo-doc/html/api/pymongo/bulk.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
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
<!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>bulk – The bulk write operations interface &mdash; 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="errors – Exceptions raised by the pymongo package" href="errors.html" />
    <link rel="prev" title="cursor – Tools for iterating over MongoDB query results" href="cursor.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 pymongo package"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="cursor.html" title="cursor – Tools for iterating over MongoDB query results"
             accesskey="P">previous</a> |</li>
        <li><a href="../../index.html">PyMongo 2.7.2 documentation</a> &raquo;</li>
          <li><a href="../index.html" >API Documentation</a> &raquo;</li>
          <li><a href="index.html" accesskey="U"><tt class="docutils literal"><span class="pre">pymongo</span></tt> &#8211; Python driver for MongoDB</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-pymongo.bulk">
<span id="bulk-the-bulk-write-operations-interface"></span><h1><tt class="xref py py-mod docutils literal"><span class="pre">bulk</span></tt> &#8211; The bulk write operations interface<a class="headerlink" href="#module-pymongo.bulk" title="Permalink to this headline"></a></h1>
<p>The bulk write operations interface.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 2.7.</span></p>
</div>
<dl class="class">
<dt id="pymongo.bulk.BulkOperationBuilder">
<em class="property">class </em><tt class="descclassname">pymongo.bulk.</tt><tt class="descname">BulkOperationBuilder</tt><big>(</big><em>collection</em>, <em>ordered=True</em><big>)</big><a class="headerlink" href="#pymongo.bulk.BulkOperationBuilder" title="Permalink to this definition"></a></dt>
<dd><p>Initialize a new BulkOperationBuilder instance.</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>: A <a class="reference internal" href="collection.html#pymongo.collection.Collection" title="pymongo.collection.Collection"><tt class="xref py py-class docutils literal"><span class="pre">Collection</span></tt></a> instance.</li>
<li><cite>ordered</cite> (optional): If <tt class="docutils literal"><span class="pre">True</span></tt> all operations will be executed
serially, in the order provided, and the entire execution will
abort on the first error. If <tt class="docutils literal"><span class="pre">False</span></tt> operations will be executed
in arbitrary order (possibly in parallel on the server), reporting
any errors that occurred after attempting all operations. Defaults
to <tt class="docutils literal"><span class="pre">True</span></tt>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">If you are using a version of MongoDB older than 2.6 you will
get much better bulk insert performance using
<a class="reference internal" href="collection.html#pymongo.collection.Collection.insert" title="pymongo.collection.Collection.insert"><tt class="xref py py-meth docutils literal"><span class="pre">insert()</span></tt></a>.</p>
</div>
<dl class="method">
<dt id="pymongo.bulk.BulkOperationBuilder.execute">
<tt class="descname">execute</tt><big>(</big><em>write_concern=None</em><big>)</big><a class="headerlink" href="#pymongo.bulk.BulkOperationBuilder.execute" title="Permalink to this definition"></a></dt>
<dd><p>Execute all provided operations.</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>write_concern (optional): the write concern for this bulk
execution.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="pymongo.bulk.BulkOperationBuilder.find">
<tt class="descname">find</tt><big>(</big><em>selector</em><big>)</big><a class="headerlink" href="#pymongo.bulk.BulkOperationBuilder.find" title="Permalink to this definition"></a></dt>
<dd><p>Specify selection criteria for bulk operations.</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 simple">
<li><cite>selector</cite> (dict): the selection criteria for update
and remove operations.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><ul class="first last simple">
<li>A <a class="reference internal" href="#pymongo.bulk.BulkWriteOperation" title="pymongo.bulk.BulkWriteOperation"><tt class="xref py py-class docutils literal"><span class="pre">BulkWriteOperation</span></tt></a> instance, used to add
update and remove operations to this bulk operation.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="pymongo.bulk.BulkOperationBuilder.insert">
<tt class="descname">insert</tt><big>(</big><em>document</em><big>)</big><a class="headerlink" href="#pymongo.bulk.BulkOperationBuilder.insert" title="Permalink to this definition"></a></dt>
<dd><p>Insert a single 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>document</cite> (dict): the document to insert</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="pymongo.bulk.BulkUpsertOperation">
<em class="property">class </em><tt class="descclassname">pymongo.bulk.</tt><tt class="descname">BulkUpsertOperation</tt><big>(</big><em>selector</em>, <em>bulk</em><big>)</big><a class="headerlink" href="#pymongo.bulk.BulkUpsertOperation" title="Permalink to this definition"></a></dt>
<dd><p>An interface for adding upsert operations.</p>
<dl class="method">
<dt id="pymongo.bulk.BulkUpsertOperation.replace_one">
<tt class="descname">replace_one</tt><big>(</big><em>replacement</em><big>)</big><a class="headerlink" href="#pymongo.bulk.BulkUpsertOperation.replace_one" title="Permalink to this definition"></a></dt>
<dd><p>Replace one entire document matching the selector criteria.</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>replacement</cite> (dict): the replacement document</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="pymongo.bulk.BulkUpsertOperation.update">
<tt class="descname">update</tt><big>(</big><em>update</em><big>)</big><a class="headerlink" href="#pymongo.bulk.BulkUpsertOperation.update" title="Permalink to this definition"></a></dt>
<dd><p>Update all documents matching the selector.</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>update</cite> (dict): the update operations to apply</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="pymongo.bulk.BulkUpsertOperation.update_one">
<tt class="descname">update_one</tt><big>(</big><em>update</em><big>)</big><a class="headerlink" href="#pymongo.bulk.BulkUpsertOperation.update_one" title="Permalink to this definition"></a></dt>
<dd><p>Update one document matching the selector.</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>update</cite> (dict): the update operations to apply</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="pymongo.bulk.BulkWriteOperation">
<em class="property">class </em><tt class="descclassname">pymongo.bulk.</tt><tt class="descname">BulkWriteOperation</tt><big>(</big><em>selector</em>, <em>bulk</em><big>)</big><a class="headerlink" href="#pymongo.bulk.BulkWriteOperation" title="Permalink to this definition"></a></dt>
<dd><p>An interface for adding update or remove operations.</p>
<dl class="method">
<dt id="pymongo.bulk.BulkWriteOperation.remove">
<tt class="descname">remove</tt><big>(</big><big>)</big><a class="headerlink" href="#pymongo.bulk.BulkWriteOperation.remove" title="Permalink to this definition"></a></dt>
<dd><p>Remove all documents matching the selector criteria.</p>
</dd></dl>

<dl class="method">
<dt id="pymongo.bulk.BulkWriteOperation.remove_one">
<tt class="descname">remove_one</tt><big>(</big><big>)</big><a class="headerlink" href="#pymongo.bulk.BulkWriteOperation.remove_one" title="Permalink to this definition"></a></dt>
<dd><p>Remove a single document matching the selector criteria.</p>
</dd></dl>

<dl class="method">
<dt id="pymongo.bulk.BulkWriteOperation.replace_one">
<tt class="descname">replace_one</tt><big>(</big><em>replacement</em><big>)</big><a class="headerlink" href="#pymongo.bulk.BulkWriteOperation.replace_one" title="Permalink to this definition"></a></dt>
<dd><p>Replace one entire document matching the selector criteria.</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>replacement</cite> (dict): the replacement document</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="pymongo.bulk.BulkWriteOperation.update">
<tt class="descname">update</tt><big>(</big><em>update</em><big>)</big><a class="headerlink" href="#pymongo.bulk.BulkWriteOperation.update" title="Permalink to this definition"></a></dt>
<dd><p>Update all documents matching the selector criteria.</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>update</cite> (dict): the update operations to apply</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="pymongo.bulk.BulkWriteOperation.update_one">
<tt class="descname">update_one</tt><big>(</big><em>update</em><big>)</big><a class="headerlink" href="#pymongo.bulk.BulkWriteOperation.update_one" title="Permalink to this definition"></a></dt>
<dd><p>Update one document matching the selector criteria.</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>update</cite> (dict): the update operations to apply</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="pymongo.bulk.BulkWriteOperation.upsert">
<tt class="descname">upsert</tt><big>(</big><big>)</big><a class="headerlink" href="#pymongo.bulk.BulkWriteOperation.upsert" title="Permalink to this definition"></a></dt>
<dd><p>Specify that all chained update operations should be
upserts.</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">Returns:</th><td class="field-body"><ul class="first last simple">
<li>A <a class="reference internal" href="#pymongo.bulk.BulkUpsertOperation" title="pymongo.bulk.BulkUpsertOperation"><tt class="xref py py-class docutils literal"><span class="pre">BulkUpsertOperation</span></tt></a> instance, used to add
update operations to this bulk operation.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="cursor.html"
                        title="previous chapter"><tt class="docutils literal"><span class="pre">cursor</span></tt> &#8211; Tools for iterating over MongoDB query results</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> &#8211; Exceptions raised by the <tt class="docutils literal"><span class="pre">pymongo</span></tt> package</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../../_sources/api/pymongo/bulk.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 pymongo package"
             >next</a> |</li>
        <li class="right" >
          <a href="cursor.html" title="cursor – Tools for iterating over MongoDB query results"
             >previous</a> |</li>
        <li><a href="../../index.html">PyMongo 2.7.2 documentation</a> &raquo;</li>
          <li><a href="../index.html" >API Documentation</a> &raquo;</li>
          <li><a href="index.html" ><tt class="docutils literal"><span class="pre">pymongo</span></tt> &#8211; Python driver for MongoDB</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2008 - 2014, MongoDB, Inc..
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
    </div>
  </body>
</html>

APT Browse - Built by Thomas Orozco.