<!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>Adds a write operation to a batch</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.mongowritebatch.html">MongoWriteBatch</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongowritebatch.construct.html">MongoWriteBatch::__construct</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.add" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoWriteBatch::add</h1>
<p class="verinfo">(PECL mongo >= 1.5.0)</p><p class="refpurpose"><span class="refname">MongoWriteBatch::add</span> — <span class="dc-title">Adds a write operation to a batch</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongowritebatch.add-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>MongoWriteBatch::add</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$item</code></span>
)</div>
<p class="para rdfs-comment">
Adds a write operation to the batch.
</p>
<p class="para">
If <code class="parameter">$item</code> causes the batch to exceed the
<em>maxWriteBatchSize</em> or <em>maxBsonObjectSize</em>
limits, the driver will internally split the batches into multiple write
commands upon calling <span class="methodname"><a href="mongowritebatch.execute.html" class="methodname">MongoWriteBatch::execute()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mongowritebatch.add-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">item</code></dt>
<dd>
<p class="para">
An array that describes a write operation. The structure of this value
depends on the batch's operation type.
<table class="doctable informaltable">
<thead>
<tr>
<th>Batch type</th>
<th>Argument expectation</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td><strong><code>MongoWriteBatch::COMMAND_INSERT</code></strong></td>
<td>
<span class="simpara">The document to add.</span>
</td>
</tr>
<tr>
<td><strong><code>MongoWriteBatch::COMMAND_UPDATE</code></strong></td>
<td>
<p class="para">Raw update operation.</p>
<p class="para">Required keys are <em>"q"</em> and <em>"u"</em>, which correspond to the <a href="mongocollection.update.html#mongocollection.update.criteria" class="link"><code class="parameter">$criteria</code></a> and <a href="mongocollection.update.html#mongocollection.update.new_object" class="link"><code class="parameter">$new_object</code></a> parameters of <span class="function"><a href="mongocollection.update.html" class="function">MongoCollection::update()</a></span>, respectively.</p>
<p class="para">Optional keys are <em>"multi"</em> and <em>"upsert"</em>, which correspond to the <a href="mongocollection.update.html#mongocollection.update.multiple" class="link"><em>"multiple"</em></a> and <a href="mongocollection.update.html#mongocollection.update.upsert" class="link"><em>"upsert"</em></a> options for <span class="function"><a href="mongocollection.update.html" class="function">MongoCollection::update()</a></span>, respectively. If unspecified, both options default to <strong><code>FALSE</code></strong>.</p>
</td>
</tr>
<tr>
<td><strong><code>MongoWriteBatch::COMMAND_DELETE</code></strong></td>
<td>
<p class="para">Raw delete operation.</p>
<p class="para">Required keys are: <em>"q"</em> and <em>"limit"</em>, which correspond to the <a href="mongocollection.remove.html#mongocollection.remove.criteria" class="link"><code class="parameter">$criteria</code></a> parameter and <a href="mongocollection.remove.html#mongocollection.remove.justone" class="link"><em>"justOne"</em></a> option of <span class="function"><a href="mongocollection.remove.html" class="function">MongoCollection::remove()</a></span>, respectively.</p>
<p class="para">The <em>"limit"</em> option is an <span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>; however, MongoDB only supports <em>0</em> (i.e. remove all matching documents) and <em>1</em> (i.e. remove at most one matching document) at this time.</p>
</td>
</tr>
</tbody>
</table>
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongowritebatch.add-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success and throws an exception on failure.
</p>
</div>
<div class="refsect1 errors" id="refsect1-mongowritebatch.add-errors">
<h3 class="title">Errors/Exceptions</h3>
<ul class="simplelist">
<li class="member"><a href="class.exception.html" class="classname">Exception</a> on parameter parsing failures</li>
<li class="member"><a href="class.exception.html" class="classname">Exception</a> on argument validation errors (e.g. missing keys)</li>
</ul>
</div>
<div class="refsect1 examples" id="refsect1-mongowritebatch.add-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1666">
<p><strong>Example #1 <span class="methodname"><strong>MongoWriteBatch::add()</strong></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">$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">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-1667">
<p><strong>Example #2 <span class="methodname"><strong>MongoWriteBatch::add()</strong></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">$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 /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="mongobindata.intro-example">
<p><strong>Example #3 <span class="methodname"><strong>MongoWriteBatch::add()</strong></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">$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">?></span>
</span>
</code></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.mongowritebatch.html">MongoWriteBatch</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongowritebatch.construct.html">MongoWriteBatch::__construct</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>
