<!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>Add an insert operation to the bulk</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-bulkwrite.delete.html">MongoDB\Driver\BulkWrite::delete</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-bulkwrite.update.html">MongoDB\Driver\BulkWrite::update</a></div>
<div class="up"><a href="class.mongodb-driver-bulkwrite.html">MongoDB\Driver\BulkWrite</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongodb-driver-bulkwrite.insert" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDB\Driver\BulkWrite::insert</h1>
<p class="verinfo">(mongodb >=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\BulkWrite::insert</span> — <span class="dc-title">Add an insert operation to the bulk</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodb-driver-bulkwrite.insert-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>MongoDB\Driver\BulkWrite::insert</strong></span>
( <span class="methodparam"><span class="type"><span class="type array|object">array|object</span></span> <code class="parameter">$document</code></span>
)</div>
<p class="para rdfs-comment">
Adds an insert operation to the
<a href="class.mongodb-driver-bulkwrite.html" class="classname">MongoDB\Driver\BulkWrite</a>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mongodb-driver-bulkwrite.insert-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">document</code> (<span class="type"><span class="type array|object">array|object</span></span>)</dt>
<dd>
<p class="para">
A document to insert.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongodb-driver-bulkwrite.insert-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the <em>_id</em> of the inserted document. If the
<code class="parameter">document</code> did not have an <em>_id</em>, the
<a href="class.mongodb-bson-objectid.html" class="classname">MongoDB\BSON\ObjectId</a> generated for the insert will
be returned.
</p>
</div>
<div class="refsect1 errors" id="refsect1-mongodb-driver-bulkwrite.insert-errors">
<h3 class="title">Errors/Exceptions</h3>
<ul class="simplelist">
<li class="member">Throws <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> on argument parsing errors.</li>
</ul>
</div>
<div class="refsect1 changelog" id="refsect1-mongodb-driver-bulkwrite.insert-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.3.0</td>
<td>
The <em>_id</em> of the inserted document is always returned.
Previously, the method only returned a value if a
<a href="class.mongodb-bson-objectid.html" class="classname">MongoDB\BSON\ObjectId</a> was generated.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-mongodb-driver-bulkwrite.insert-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1701">
<p><strong>Example #1 <span class="function"><strong>MongoDB\Driver\BulkWrite::insert()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$bulk </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">BulkWrite</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$document1 </span><span style="color: #007700">= [</span><span style="color: #DD0000">'title' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'one'</span><span style="color: #007700">];<br /></span><span style="color: #0000BB">$document2 </span><span style="color: #007700">= [</span><span style="color: #DD0000">'_id' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'custom ID'</span><span style="color: #007700">, </span><span style="color: #DD0000">'title' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'two'</span><span style="color: #007700">];<br /></span><span style="color: #0000BB">$document3 </span><span style="color: #007700">= [</span><span style="color: #DD0000">'_id' </span><span style="color: #007700">=> new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">ObjectId</span><span style="color: #007700">, </span><span style="color: #DD0000">'title' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'three'</span><span style="color: #007700">];<br /><br /></span><span style="color: #0000BB">$_id1 </span><span style="color: #007700">= </span><span style="color: #0000BB">$bulk</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">(</span><span style="color: #0000BB">$document1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$_id2 </span><span style="color: #007700">= </span><span style="color: #0000BB">$bulk</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">(</span><span style="color: #0000BB">$document2</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$_id3 </span><span style="color: #007700">= </span><span style="color: #0000BB">$bulk</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">(</span><span style="color: #0000BB">$document3</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$_id1</span><span style="color: #007700">, </span><span style="color: #0000BB">$_id2</span><span style="color: #007700">, </span><span style="color: #0000BB">$_id3</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$manager </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">Manager</span><span style="color: #007700">(</span><span style="color: #DD0000">'mongodb://localhost:27017'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$manager</span><span style="color: #007700">-></span><span style="color: #0000BB">executeBulkWrite</span><span style="color: #007700">(</span><span style="color: #DD0000">'db.collection'</span><span style="color: #007700">, </span><span style="color: #0000BB">$bulk</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>
object(MongoDB\BSON\ObjectId)#3 (1) {
["oid"]=>
string(24) "54d51146bd21b91405401d92"
}
NULL
NULL
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mongodb-driver-bulkwrite.insert-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><span class="methodname"><a href="mongodb-driver-manager.executebulkwrite.html" class="methodname" rel="rdfs-seeAlso">MongoDB\Driver\Manager::executeBulkWrite()</a> - Execute one or more write operations</span></li>
<li class="member"><a href="class.mongodb-driver-writeresult.html" class="classname">MongoDB\Driver\WriteResult</a></li>
<li class="member"><a href="class.mongodb-bson-objectid.html" class="classname">MongoDB\BSON\ObjectId</a></li>
<li class="member"><span class="interfacename"><a href="class.mongodb-bson-persistable.html" class="interfacename">MongoDB\BSON\Persistable</a></span></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-bulkwrite.delete.html">MongoDB\Driver\BulkWrite::delete</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-bulkwrite.update.html">MongoDB\Driver\BulkWrite::update</a></div>
<div class="up"><a href="class.mongodb-driver-bulkwrite.html">MongoDB\Driver\BulkWrite</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
