<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Executes a batch of write operations</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongowritebatch.construct.html">MongoWriteBatch::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.mongoinsertbatch.html">MongoInsertBatch</a></div>
<div class="up"><a href="class.mongowritebatch.html">MongoWriteBatch</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongowritebatch.execute" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoWriteBatch::execute</h1>
<p class="verinfo">(PECL mongo >= 1.5.0)</p><p class="refpurpose"><span class="refname">MongoWriteBatch::execute</span> — <span class="dc-title">Executes a batch of write operations</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongowritebatch.execute-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>MongoWriteBatch::execute</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$write_options</code></span>
)</div>
<p class="para rdfs-comment">
Executes the batch of write operations.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mongowritebatch.execute-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">write_options</code></dt>
<dd>
<p class="para">
See <a href="mongowritebatch.construct.html#mongowritebatch.construct.write_options" class="link">MongoWriteBatch::__construct</a>.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongowritebatch.execute-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array containing statistical information for the full batch.
If the batch had to be split into multiple batches, the return value will aggregate
the values from individual batches and return only the totals.
</p>
<p class="para">
If the batch was empty, an array containing only the 'ok' field is returned (as <strong><code>TRUE</code></strong>) although
nothing will be shipped over the wire (<acronym>NOOP</acronym>).
</p>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Array key</th>
<th>Value meaning</th>
<th>Returned for batch type</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>nInserted</td>
<td>Number of inserted documents</td>
<td>MongoWriteBatch::COMMAND_INSERT batch</td>
</tr>
<tr>
<td>nMatched</td>
<td>Number of documents matching the query criteria</td>
<td>MongoWriteBatch::COMMAND_UPDATE batch</td>
</tr>
<tr>
<td>nModified</td>
<td>Number of documents actually needed to be modied</td>
<td>MongoWriteBatch::COMMAND_UPDATE batch</td>
</tr>
<tr>
<td>nUpserted</td>
<td>Number of upserted documents</td>
<td>MongoWriteBatch::COMMAND_UPDATE batch</td>
</tr>
<tr>
<td>nRemoved</td>
<td>Number of documents removed</td>
<td>MongoWriteBatch::COMMAND_DELETE batch</td>
</tr>
<tr>
<td>ok</td>
<td>Command success indicator</td>
<td>All</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 errors" id="refsect1-mongowritebatch.execute-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
A <a href="class.mongowriteconcernexception.html" class="classname">MongoWriteConcernException</a> exception is thrown on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-mongowritebatch.execute-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1669">
<p><strong>Example #1 <span class="methodname"><a href="mongowritebatch.add.html" class="methodname">MongoWriteBatch::add()</a></span> example</strong></p>
<div class="example-contents"><p>
Batching up multiple insert operations
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$mc </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoClient</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$collection </span><span style="color: #007700">= </span><span style="color: #0000BB">$mc</span><span style="color: #007700">-></span><span style="color: #0000BB">selectCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"test"</span><span style="color: #007700">, </span><span style="color: #DD0000">"test"</span><span style="color: #007700">);<br /><br /><br /></span><span style="color: #0000BB">$docs </span><span style="color: #007700">= array();<br /></span><span style="color: #0000BB">$docs</span><span style="color: #007700">[] = array(</span><span style="color: #DD0000">"my" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"demo"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$docs</span><span style="color: #007700">[] = array(</span><span style="color: #DD0000">"is" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"working"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$docs</span><span style="color: #007700">[] = array(</span><span style="color: #DD0000">"pretty" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"well"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$batch </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoInsertBatch</span><span style="color: #007700">(</span><span style="color: #0000BB">$collection</span><span style="color: #007700">);<br />foreach(</span><span style="color: #0000BB">$docs </span><span style="color: #007700">as </span><span style="color: #0000BB">$document</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$batch</span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #0000BB">$document</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">$retval </span><span style="color: #007700">= </span><span style="color: #0000BB">$batch</span><span style="color: #007700">-></span><span style="color: #0000BB">execute</span><span style="color: #007700">(array(</span><span style="color: #DD0000">"w" </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$retval</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(2) {
["nInserted"]=>
int(3)
["ok"]=>
bool(true)
}
</pre></div>
</div>
</div>
<div class="example" id="example-1670">
<p><strong>Example #2 <span class="methodname"><a href="mongowritebatch.add.html" class="methodname">MongoWriteBatch::add()</a></span> example</strong></p>
<div class="example-contents"><p>
Batching up multiple update operations
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$mc </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoClient</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$collection </span><span style="color: #007700">= </span><span style="color: #0000BB">$mc</span><span style="color: #007700">-></span><span style="color: #0000BB">selectCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"test"</span><span style="color: #007700">, </span><span style="color: #DD0000">"test"</span><span style="color: #007700">);<br /><br /><br /></span><span style="color: #0000BB">$item1 </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">"q" </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">"my" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"demo"</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">"u" </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">'$set' </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">"try" </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">)),<br /> </span><span style="color: #DD0000">"multi" </span><span style="color: #007700">=> </span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #FF8000">/* default value */<br /> </span><span style="color: #DD0000">"upsert" </span><span style="color: #007700">=> </span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #FF8000">/* default value */<br /></span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$item2 </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">"q" </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">"is" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"working"</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">"u" </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">'$set' </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">"try" </span><span style="color: #007700">=> </span><span style="color: #0000BB">2</span><span style="color: #007700">)),<br /> </span><span style="color: #DD0000">"multi" </span><span style="color: #007700">=> </span><span style="color: #0000BB">true</span><span style="color: #007700">,<br />);<br /></span><span style="color: #0000BB">$item3 </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">"q" </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">"created" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"new-document"</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">"u" </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">'$set' </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">"try" </span><span style="color: #007700">=> </span><span style="color: #0000BB">3</span><span style="color: #007700">)),<br /> </span><span style="color: #DD0000">"upsert" </span><span style="color: #007700">=> </span><span style="color: #0000BB">true</span><span style="color: #007700">,<br />);<br /><br /></span><span style="color: #0000BB">$batch </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoUpdateBatch</span><span style="color: #007700">(</span><span style="color: #0000BB">$collection</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$batch</span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #0000BB">$item1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$batch</span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #0000BB">$item2</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$batch</span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #0000BB">$item3</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$retval </span><span style="color: #007700">= </span><span style="color: #0000BB">$batch</span><span style="color: #007700">-></span><span style="color: #0000BB">execute</span><span style="color: #007700">(array(</span><span style="color: #DD0000">"w" </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$retval</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(4) {
["nMatched"]=>
int(18)
["nModified"]=>
int(2)
["nUpserted"]=>
int(0)
["ok"]=>
bool(true)
}
</pre></div>
</div>
</div>
<div class="example" id="example-1671">
<p><strong>Example #3 <span class="methodname"><a href="mongowritebatch.add.html" class="methodname">MongoWriteBatch::add()</a></span> example</strong></p>
<div class="example-contents"><p>
Batching up multiple delete operations
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$mc </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoClient</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$collection </span><span style="color: #007700">= </span><span style="color: #0000BB">$mc</span><span style="color: #007700">-></span><span style="color: #0000BB">selectCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"test"</span><span style="color: #007700">, </span><span style="color: #DD0000">"test"</span><span style="color: #007700">);<br /><br /><br /></span><span style="color: #0000BB">$item1 </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">"q" </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">"my" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"demo"</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">"limit" </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">,<br />);<br /></span><span style="color: #0000BB">$item2 </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">"q" </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">"try" </span><span style="color: #007700">=> </span><span style="color: #0000BB">3</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">"limit" </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">,<br />);<br /><br /><br /></span><span style="color: #0000BB">$batch </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDeleteBatch</span><span style="color: #007700">(</span><span style="color: #0000BB">$collection</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$batch</span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #0000BB">$item1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$batch</span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #0000BB">$item2</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$retval </span><span style="color: #007700">= </span><span style="color: #0000BB">$batch</span><span style="color: #007700">-></span><span style="color: #0000BB">execute</span><span style="color: #007700">(array(</span><span style="color: #DD0000">"w" </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$retval</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(2) {
["nRemoved"]=>
int(1)
["ok"]=>
bool(true)
}
</pre></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongowritebatch.construct.html">MongoWriteBatch::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.mongoinsertbatch.html">MongoInsertBatch</a></div>
<div class="up"><a href="class.mongowritebatch.html">MongoWriteBatch</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
