<!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>Creates a new 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.add.html">MongoWriteBatch::add</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongowritebatch.execute.html">MongoWriteBatch::execute</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.construct" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoWriteBatch::__construct</h1>
<p class="verinfo">(PECL mongo >= 1.5.0)</p><p class="refpurpose"><span class="refname">MongoWriteBatch::__construct</span> — <span class="dc-title">Creates a new batch of write operations</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongowritebatch.construct-description">
<h3 class="title">Description</h3>
<div class="constructorsynopsis dc-description">
<span class="modifier">protected</span> <span class="methodname"><strong>MongoWriteBatch::__construct</strong></span>
( <span class="methodparam"><span class="type"><a href="class.mongocollection.html" class="type MongoCollection">MongoCollection</a></span> <code class="parameter">$collection</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$batch_type</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$write_options</code></span>
]] )</div>
<p class="para rdfs-comment">
Constructs a new MongoWriteBatch.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This is a protected constructor. Please use one of the classes inheriting <a href="class.mongowritebatch.html" class="classname">MongoWriteBatch</a>.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-mongowritebatch.construct-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">collection</code></dt>
<dd>
<p class="para">The <a href="class.mongocollection.html" class="classname">MongoCollection</a> to execute the batch on. Its <a href="mongo.writeconcerns.html" class="link">write concern</a> will be copied and used as the default write concern if none is given as <code class="parameter">$write_options</code> or during <span class="methodname"><a href="mongowritebatch.execute.html" class="methodname">MongoWriteBatch::execute()</a></span>.</p></dd>
<dt>
<code class="parameter">batch_type</code></dt>
<dd>
<p class="para">
One of:
<ul class="simplelist">
<li class="member"><em>0</em> - make an MongoWriteBatch::COMMAND_INSERT batch</li>
<li class="member"><em>1</em> - make an MongoWriteBatch::COMMAND_UPDATE batch</li>
<li class="member"><em>2</em> - make a MongoWriteBatch::COMMAND_DELETE batch</li>
</ul>
</p>
</dd>
<dt id="mongowritebatch.construct.write_options"><code class="parameter">write_options</code></dt>
<dd>
<p class="para">An array of Write Options.<table class="doctable informaltable"><thead><tr><th>key</th><th>value meaning</th></tr>
</thead>
<tbody class="tbody"><tr><td>w (int|string)</td><td><a href="mongo.writeconcerns.html" class="link">Write concern</a> value</td></tr>
<tr><td>wtimeout (int)</td><td><a href="mongo.writeconcerns.html" class="link">Maximum time to wait for replication</a></td></tr>
<tr><td>ordered</td><td>Determines if MongoDB must apply this batch in order. Ordered writes execute serially (i.e. one at a time) and execution will stop after the first error. Unordered writes may execute in parallel and execution will not stop after the first error. Defaults to <strong><code>TRUE</code></strong></td></tr>
<tr><td>j (bool)</td><td>Wait for journaling on the primary. This value is discouraged, use WriteConcern instead</td></tr>
<tr><td>fsync (bool)</td><td>Wait for fsync on the primary. This value is discouraged, use WriteConcern instead</td></tr>
</tbody></table>
</p></dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongowritebatch.construct-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A new MongoWriteBatch of type <code class="parameter">batch_type</code>.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-mongowritebatch.construct-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><a href="class.mongoinsertbatch.html" class="classname">MongoInsertBatch</a></li>
<li class="member"><a href="class.mongoupdatebatch.html" class="classname">MongoUpdateBatch</a></li>
<li class="member"><a href="class.mongodeletebatch.html" class="classname">MongoDeleteBatch</a></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongowritebatch.add.html">MongoWriteBatch::add</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongowritebatch.execute.html">MongoWriteBatch::execute</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>
