<!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>Inserts multiple documents into this collection</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongocollection.aggregate.html">MongoCollection::aggregate</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongocollection.construct.html">MongoCollection::__construct</a></div>
<div class="up"><a href="class.mongocollection.html">MongoCollection</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongocollection.batchinsert" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoCollection::batchInsert</h1>
<p class="verinfo">(PECL mongo >=0.9.0)</p><p class="refpurpose"><span class="refname">MongoCollection::batchInsert</span> — <span class="dc-title">Inserts multiple documents into this collection</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongocollection.batchinsert-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>MongoCollection::batchInsert</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$a</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$options</code><span class="initializer"> = array()</span></span>
] )</div>
</div>
<div class="refsect1 parameters" id="refsect1-mongocollection.batchinsert-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term">
<em><code class="parameter">a</code></em>
</span>
<dd>
<p class="para">
An array of arrays or objects. If any objects are used, they may not have
protected or private properties.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
If the documents to insert do not have an <em>_id</em> key or
property, a new <a href="class.mongoid.html" class="classname">MongoId</a> instance will be created
and assigned to it. See <span class="function"><a href="mongocollection.insert.html" class="function">MongoCollection::insert()</a></span> for
additional information on this behavior.
</p>
</p></blockquote>
</dd>
</dt>
<dt>
<span class="term">
<em><code class="parameter">options</code></em>
</span>
<dd>
<p class="para">
Options for the inserts.
<ul class="itemizedlist">
<li class="listitem">
<p class="para">
<em>"continueOnError"</em>
</p>
<p class="para">
Boolean, defaults to <strong><code>FALSE</code></strong>. If set, the database will not stop
processing a bulk insert if one fails (eg due to duplicate IDs).
This makes bulk insert behave similarly to a series of single
inserts, except that calling <span class="function"><a href="mongodb.lasterror.html" class="function">MongoDB::lastError()</a></span>
will have an error set if any insert fails, not just the last one.
If multiple errors occur, only the most recent will be reported by
<span class="function"><a href="mongodb.lasterror.html" class="function">MongoDB::lastError()</a></span>.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
Please note that <em>continueOnError</em> affects errors
on the database side only. If you try to insert a document that has
errors (for example it contains a key with an empty name), then the
document is not even transferred to the database as the driver
detects this error and bails out.
<em>continueOnError</em> has no effect on errors detected
in the documents by the driver.
</p>
</p></blockquote>
</li>
<li class="listitem"><p class="para"><em>"fsync"</em></p><p class="para">Boolean, defaults to <strong><code>FALSE</code></strong>. If journalling is enabled, it works exactly like <em>"j"</em>. If journalling is not enabled, it forces the insert to be synced to disk before returning success. If <strong><code>TRUE</code></strong>, an acknowledged insert is implied and will override setting <em>w</em> to <em>0</em>.</p><blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">This option is <em class="emphasis">deprecated</em>. Please use the <em>"j"</em> option instead.</p></p></blockquote></li>
<li class="listitem"><p class="para"><em>"j"</em></p><p class="para">Boolean, defaults to <strong><code>FALSE</code></strong>. Forces the insert to be synced to the journal before returning success. If <strong><code>TRUE</code></strong>, an acknowledged insert is implied and will override setting <em>w</em> to <em>0</em>.</p></li>
<li class="listitem"><p class="para"><em>"w"</em></p><p class="para">See <a href="mongo.writeconcerns.html" class="link">WriteConcerns</a>. The default value for <a href="class.mongoclient.html" class="classname">MongoClient</a> is <em>1</em>.</p></li>
<li class="listitem"><p class="para"><em>"wtimeout"</em></p><p class="para">How long to wait for <a href="mongo.writeconcerns.html" class="link">WriteConcern</a> acknowledgement. The default value for <a href="class.mongoclient.html" class="classname">MongoClient</a> is <em>10000</em> milliseconds.</p></li>
<li class="listitem"><p class="para"><em>"safe"</em></p><p class="para"><em class="emphasis">Deprecated</em>. Please use the <a href="mongo.writeconcerns.html" class="link">WriteConcern</a> <em>w</em> option.</p></li>
<li class="listitem"><p class="para"><em>"timeout"</em></p><p class="para">Integer, defaults to <em>MongoCursor::$timeout</em>. If acknowledged writes are used, this sets how long (in milliseconds) for the client to wait for a database response. If the database does not respond within the timeout period, a <a href="class.mongocursortimeoutexception.html" class="classname">MongoCursorTimeoutException</a> will be thrown.</p></li>
</ul>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongocollection.batchinsert-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
If the <em>w</em> parameter is set to acknowledge the write,
returns an associative array with the status of the inserts ("ok") and any
error that may have occurred ("err"). Otherwise, returns <strong><code>TRUE</code></strong> if the
batch insert was successfully sent, <strong><code>FALSE</code></strong> otherwise.
</p>
</div>
<div class="refsect1 errors" id="refsect1-mongocollection.batchinsert-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <a href="class.mongoexception.html" class="classname">MongoException</a> if any inserted documents are
empty or if they contains zero-length keys. Attempting to insert an object
with protected and private properties will cause a zero-length key error.
</p>
<p class="para">Throws <a href="class.mongocursorexception.html" class="classname">MongoCursorException</a> if the "w" option is set and the write fails.</p><p class="para">Throws <a href="class.mongocursortimeoutexception.html" class="classname">MongoCursorTimeoutException</a> if the "w" option is set to a value greater than one and the operation takes longer than <var class="varname"><var class="varname">MongoCursor::$timeout</var></var> milliseconds to complete. This does not kill the operation on the server, it is a client-side timeout. The operation in <em>MongoCollection::$wtimeout</em> is milliseconds.</p>
</div>
<div class="refsect1 changelog" id="refsect1-mongocollection.batchinsert-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>1.2.7</td>
<td>Added <em>"continueOnError"</em> option.</td>
</tr>
<tr>
<td>1.0.9</td>
<td>
<p class="para">
Added ability to pass integers to the <em>"safe"</em> option,
which previously only accepted booleans.
</p>
<p class="para">
Added <em>"fsync"</em> option.
</p>
</td>
</tr>
<tr>
<td>1.0.5</td>
<td>Added <em><code class="parameter">options</code></em> parameter.</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-mongocollection.batchinsert-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1434">
<p><strong>Example #1 <span class="function"><strong>MongoCollection::batchInsert()</strong></span> example</strong></p>
<div class="example-contents"><p>
Batch insertion is a quick way to add many elements to the database at once
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$users </span><span style="color: #007700">= array();<br />for (</span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700"><</span><span style="color: #0000BB">100</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700">++) {<br /> </span><span style="color: #0000BB">$users</span><span style="color: #007700">[] = array(</span><span style="color: #DD0000">'username' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'user'</span><span style="color: #007700">.</span><span style="color: #0000BB">$i</span><span style="color: #007700">, </span><span style="color: #DD0000">'i' </span><span style="color: #007700">=> </span><span style="color: #0000BB">$i</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">$mongo </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoClient</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$collection </span><span style="color: #007700">= </span><span style="color: #0000BB">$mongo</span><span style="color: #007700">-></span><span style="color: #0000BB">my_db</span><span style="color: #007700">-></span><span style="color: #0000BB">users</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$collection</span><span style="color: #007700">-></span><span style="color: #0000BB">drop</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$collection</span><span style="color: #007700">-></span><span style="color: #0000BB">batchInsert</span><span style="color: #007700">(</span><span style="color: #0000BB">$users</span><span style="color: #007700">);<br /><br />foreach (</span><span style="color: #0000BB">$users </span><span style="color: #007700">as </span><span style="color: #0000BB">$user</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$user</span><span style="color: #007700">[</span><span style="color: #DD0000">'_id'</span><span style="color: #007700">].</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">; </span><span style="color: #FF8000">// populated with instanceof MongoId<br /></span><span style="color: #007700">}<br /><br /></span><span style="color: #0000BB">$users </span><span style="color: #007700">= </span><span style="color: #0000BB">$collection</span><span style="color: #007700">-></span><span style="color: #0000BB">find</span><span style="color: #007700">()-></span><span style="color: #0000BB">sort</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'i' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">));<br />foreach (</span><span style="color: #0000BB">$users </span><span style="color: #007700">as </span><span style="color: #0000BB">$user</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$user</span><span style="color: #007700">[</span><span style="color: #DD0000">'username'</span><span style="color: #007700">]);<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
4bf43ac68ead0e1971000000
4bf43ac68ead0e1971010000
4bf43ac68ead0e1971020000
...
string(5) "user1"
string(5) "user2"
string(5) "user3"
...
</pre></div>
</div>
</div>
<div class="example" id="example-1435">
<p><strong>Example #2 <span class="function"><strong>MongoCollection::batchInsert()</strong></span> example with
ignoring errors</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$con </span><span style="color: #007700">= new </span><span style="color: #0000BB">Mongo</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$db </span><span style="color: #007700">= </span><span style="color: #0000BB">$con</span><span style="color: #007700">-></span><span style="color: #0000BB">demo</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$doc1 </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">'_id' </span><span style="color: #007700">=> new </span><span style="color: #0000BB">MongoId</span><span style="color: #007700">(</span><span style="color: #DD0000">'4cb4ab6d7addf98506010001'</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">'id' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'desc' </span><span style="color: #007700">=> </span><span style="color: #DD0000">"ONE"</span><span style="color: #007700">,<br />);<br /></span><span style="color: #0000BB">$doc2 </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">'_id' </span><span style="color: #007700">=> new </span><span style="color: #0000BB">MongoId</span><span style="color: #007700">(</span><span style="color: #DD0000">'4cb4ab6d7addf98506010002'</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">'id' </span><span style="color: #007700">=> </span><span style="color: #0000BB">2</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'desc' </span><span style="color: #007700">=> </span><span style="color: #DD0000">"TWO"</span><span style="color: #007700">,<br />);<br /></span><span style="color: #0000BB">$doc3 </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">'_id' </span><span style="color: #007700">=> new </span><span style="color: #0000BB">MongoId</span><span style="color: #007700">(</span><span style="color: #DD0000">'4cb4ab6d7addf98506010002'</span><span style="color: #007700">), </span><span style="color: #FF8000">// same _id as above<br /> </span><span style="color: #DD0000">'id' </span><span style="color: #007700">=> </span><span style="color: #0000BB">3</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'desc' </span><span style="color: #007700">=> </span><span style="color: #DD0000">"THREE"</span><span style="color: #007700">,<br />);<br /></span><span style="color: #0000BB">$doc4 </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">'_id' </span><span style="color: #007700">=> new </span><span style="color: #0000BB">MongoId</span><span style="color: #007700">(</span><span style="color: #DD0000">'4cb4ab6d7addf98506010004'</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">'id' </span><span style="color: #007700">=> </span><span style="color: #0000BB">4</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'desc' </span><span style="color: #007700">=> </span><span style="color: #DD0000">"FOUR"</span><span style="color: #007700">,<br />);<br /><br /></span><span style="color: #0000BB">$c </span><span style="color: #007700">= </span><span style="color: #0000BB">$db</span><span style="color: #007700">-></span><span style="color: #0000BB">selectCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">'c'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$c</span><span style="color: #007700">-></span><span style="color: #0000BB">batchInsert</span><span style="color: #007700">(<br /> array(</span><span style="color: #0000BB">$doc1</span><span style="color: #007700">, </span><span style="color: #0000BB">$doc2</span><span style="color: #007700">, </span><span style="color: #0000BB">$doc3</span><span style="color: #007700">, </span><span style="color: #0000BB">$doc4</span><span style="color: #007700">),<br /> array(</span><span style="color: #DD0000">'continueOnError' </span><span style="color: #007700">=> </span><span style="color: #0000BB">true</span><span style="color: #007700">)<br />);<br /><br /></span><span style="color: #0000BB">$docs </span><span style="color: #007700">= </span><span style="color: #0000BB">$c</span><span style="color: #007700">-></span><span style="color: #0000BB">find</span><span style="color: #007700">();<br />foreach (</span><span style="color: #0000BB">$docs </span><span style="color: #007700">as </span><span style="color: #0000BB">$doc</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$doc</span><span style="color: #007700">[</span><span style="color: #DD0000">'desc'</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
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
string(3) "ONE"
string(3) "TWO"
string(4) "FOUR"
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mongocollection.batchinsert-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"> <span class="function"><a href="mongocollection.insert.html" class="function" rel="rdfs-seeAlso">MongoCollection::insert()</a> - Inserts a document into the collection</span></li>
<li class="member"> <span class="function"><a href="mongocollection.update.html" class="function" rel="rdfs-seeAlso">MongoCollection::update()</a> - Update records based on a given criteria</span></li>
<li class="member"> <span class="function"><a href="mongocollection.find.html" class="function" rel="rdfs-seeAlso">MongoCollection::find()</a> - Queries this collection, returning a MongoCursor
for the result set</span></li>
<li class="member"> <span class="function"><a href="mongocollection.remove.html" class="function" rel="rdfs-seeAlso">MongoCollection::remove()</a> - Remove records from this collection</span></li>
<li class="member">MongoDB core docs on <a href="docs.mongodb.org/manual/tutorial/insert-documents/" class="link external">» insert</a>.</li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongocollection.aggregate.html">MongoCollection::aggregate</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongocollection.construct.html">MongoCollection::__construct</a></div>
<div class="up"><a href="class.mongocollection.html">MongoCollection</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
