<!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>Returns an array of identifiers for upserted documents</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-writeresult.getupsertedcount.html">MongoDB\Driver\WriteResult::getUpsertedCount</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-writeresult.getwriteconcernerror.html">MongoDB\Driver\WriteResult::getWriteConcernError</a></div>
<div class="up"><a href="class.mongodb-driver-writeresult.html">MongoDB\Driver\WriteResult</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongodb-driver-writeresult.getupsertedids" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDB\Driver\WriteResult::getUpsertedIds</h1>
<p class="verinfo">(mongodb >=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\WriteResult::getUpsertedIds</span> — <span class="dc-title">Returns an array of identifiers for upserted documents</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodb-driver-writeresult.getupsertedids-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>MongoDB\Driver\WriteResult::getUpsertedIds</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mongodb-driver-writeresult.getupsertedids-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongodb-driver-writeresult.getupsertedids-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array of identifiers (i.e. <em>"_id"</em> field values)
for upserted documents. The array keys will correspond to the index of the
write operation (from <a href="class.mongodb-driver-bulkwrite.html" class="classname">MongoDB\Driver\BulkWrite</a>)
responsible for the upsert.
</p>
</div>
<div class="refsect1 errors" id="refsect1-mongodb-driver-writeresult.getupsertedids-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 examples" id="refsect1-mongodb-driver-writeresult.getupsertedids-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1746">
<p><strong>Example #1 <span class="function"><strong>MongoDB\Driver\WriteResult::getUpsertedIds()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$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">;<br /><br /></span><span style="color: #0000BB">$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 /></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: #DD0000">'x' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">]);<br /></span><span style="color: #0000BB">$bulk</span><span style="color: #007700">-></span><span style="color: #0000BB">update</span><span style="color: #007700">([</span><span style="color: #DD0000">'x' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">], [</span><span style="color: #DD0000">'$set' </span><span style="color: #007700">=> [</span><span style="color: #DD0000">'y' </span><span style="color: #007700">=> </span><span style="color: #0000BB">3</span><span style="color: #007700">]]);<br /></span><span style="color: #0000BB">$bulk</span><span style="color: #007700">-></span><span style="color: #0000BB">update</span><span style="color: #007700">([</span><span style="color: #DD0000">'x' </span><span style="color: #007700">=> </span><span style="color: #0000BB">2</span><span style="color: #007700">], [</span><span style="color: #DD0000">'$set' </span><span style="color: #007700">=> [</span><span style="color: #DD0000">'y' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">]], [</span><span style="color: #DD0000">'upsert' </span><span style="color: #007700">=> </span><span style="color: #0000BB">true</span><span style="color: #007700">]);<br /></span><span style="color: #0000BB">$bulk</span><span style="color: #007700">-></span><span style="color: #0000BB">update</span><span style="color: #007700">([</span><span style="color: #DD0000">'x' </span><span style="color: #007700">=> </span><span style="color: #0000BB">3</span><span style="color: #007700">], [</span><span style="color: #DD0000">'$set' </span><span style="color: #007700">=> [</span><span style="color: #DD0000">'y' </span><span style="color: #007700">=> </span><span style="color: #0000BB">2</span><span style="color: #007700">]], [</span><span style="color: #DD0000">'upsert' </span><span style="color: #007700">=> </span><span style="color: #0000BB">true</span><span style="color: #007700">]);<br /></span><span style="color: #0000BB">$bulk</span><span style="color: #007700">-></span><span style="color: #0000BB">delete</span><span style="color: #007700">([</span><span style="color: #DD0000">'x' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">]);<br /><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">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">-></span><span style="color: #0000BB">getUpsertedIds</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>
array(2) {
[2]=>
object(MongoDB\BSON\ObjectId)#4 (1) {
["oid"]=>
string(24) "580e62a224f2302f191b880b"
}
[3]=>
object(MongoDB\BSON\ObjectId)#5 (1) {
["oid"]=>
string(24) "580e62a224f2302f191b880c"
}
}
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mongodb-driver-writeresult.getupsertedids-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><span class="methodname"><a href="mongodb-driver-writeresult.getupsertedcount.html" class="methodname" rel="rdfs-seeAlso">MongoDB\Driver\WriteResult::getUpsertedCount()</a> - Returns the number of documents inserted by an upsert</span></li>
<li class="member"><span class="methodname"><a href="mongodb-driver-writeresult.isacknowledged.html" class="methodname" rel="rdfs-seeAlso">MongoDB\Driver\WriteResult::isAcknowledged()</a> - Returns whether the write was acknowledged</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-writeresult.getupsertedcount.html">MongoDB\Driver\WriteResult::getUpsertedCount</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-writeresult.getwriteconcernerror.html">MongoDB\Driver\WriteResult::getWriteConcernError</a></div>
<div class="up"><a href="class.mongodb-driver-writeresult.html">MongoDB\Driver\WriteResult</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
