<!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 update 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.insert.html">MongoDB\Driver\BulkWrite::insert</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.mongodb-driver-session.html">MongoDB\Driver\Session</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.update" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDB\Driver\BulkWrite::update</h1>
<p class="verinfo">(mongodb >=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\BulkWrite::update</span> — <span class="dc-title">Add an update operation to the bulk</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodb-driver-bulkwrite.update-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>MongoDB\Driver\BulkWrite::update</strong></span>
( <span class="methodparam"><span class="type"><span class="type array|object">array|object</span></span> <code class="parameter">$filter</code></span>
, <span class="methodparam"><span class="type"><span class="type array|object">array|object</span></span> <code class="parameter">$newObj</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$updateOptions</code></span>
] )</div>
<p class="para rdfs-comment">
Adds an update 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.update-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">filter</code> (<span class="type"><span class="type array|object">array|object</span></span>)</dt>
<dd>
<p class="para">
The <a href="https://docs.mongodb.com/manual/tutorial/query-documents/" class="link external">» query predicate</a>.
An empty predicate will match all documents in the collection.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="simpara">
When evaluating query criteria, MongoDB compares types and values according to its own <a href="https://docs.mongodb.com/manual/reference/bson-type-comparison-order/" class="link external">» comparison rules for BSON types</a>, which differs from PHP's <a href="types.comparisons.html" class="link">comparison</a> and <a href="language.types.type-juggling.html" class="link">type juggling</a> rules. When matching a special BSON type the query criteria should use the respective <a href="book.bson.html" class="link">BSON class</a> (e.g. use <a href="class.mongodb-bson-objectid.html" class="classname">MongoDB\BSON\ObjectId</a> to match an <a href="https://docs.mongodb.com/manual/reference/object-id/" class="link external">» ObjectId</a>).
</span>
</p></blockquote>
</dd>
<dt>
<code class="parameter">newObj</code> (<span class="type"><span class="type array|object">array|object</span></span>)</dt>
<dd>
<p class="para">
A document containing either update operators (e.g.
<em>$set</em>) or a replacement document (i.e.
<em class="emphasis">only</em> <em>field:value</em> expressions).
</p>
</dd>
<dt>
<code class="parameter">updateOptions</code></dt>
<dd>
<p class="para">
<table class="doctable table">
<caption><strong>updateOptions</strong></caption>
<thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>arrayFilters</td>
<td><span class="type"><span class="type array|object">array|object</span></span></td>
<td>
<p class="para">
An array of filter documents that determines which array elements to
modify for an update operation on an array field. See
<a href="https://docs.mongodb.com/manual/reference/command/update/#update-command-arrayfilters" class="link external">» Specify arrayFilters for Array Update Operations</a>
in the MongoDB manual for more information.
</p>
<p class="para">
This option is available in MongoDB 3.6+ and will result in an
exception at execution time if specified for an older server
version.
</p>
</td>
</tr>
<tr>
<td>collation</td>
<td><span class="type"><span class="type array|object">array|object</span></span></td>
<td>
<p class="para">
<a href="https://docs.mongodb.com/master/reference/collation/" class="link external">» Collation</a> allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the <em>"locale"</em> field is mandatory; all other collation fields are optional. For descriptions of the fields, see <a href="https://docs.mongodb.com/master/reference/collation/#collation-document" class="link external">» Collation Document</a>.
</p>
<p class="para">
If the collation is unspecified but the collection has a default collation, the operation uses the collation specified for the collection. If no collation is specified for the collection or for the operation, MongoDB uses the simple binary comparison used in prior versions for string comparisons.
</p>
<p class="para">
This option is available in MongoDB 3.4+ and will result in an exception at execution time if specified for an older server version.
</p>
</td>
</tr>
<tr>
<td>multi</td>
<td><span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span></td>
<td>
Update only the first matching document if <strong><code>FALSE</code></strong>, or all
matching documents <strong><code>TRUE</code></strong>. This option cannot be <strong><code>TRUE</code></strong> if
<code class="parameter">newObj</code> is a replacement document.
</td>
<td><strong><code>FALSE</code></strong></td>
</tr>
<tr>
<td>upsert</td>
<td><span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span></td>
<td>
If <code class="parameter">filter</code> does not match an existing document,
insert a <em class="emphasis">single</em> document. The document will be
created from <code class="parameter">newObj</code> if it is a replacement
document (i.e. no update operators); otherwise, the operators in
<code class="parameter">newObj</code> will be applied to
<code class="parameter">filter</code> to create the new document.
</td>
<td><strong><code>FALSE</code></strong></td>
</tr>
</tbody>
</table>
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongodb-driver-bulkwrite.update-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 errors" id="refsect1-mongodb-driver-bulkwrite.update-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.update-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.5.0</td>
<td>
Using the <em>"arrayFilters"</em> option will result in an
exception at execution time if unsupported by the server. Previously,
no exception would be thrown and the option may have been ignored.
</td>
</tr>
<tr>
<td>1.4.0</td>
<td>
Added the <em>"arrayFilters"</em> option.
</td>
</tr>
<tr>
<td>1.2.0</td>
<td>
Added the <em>"collation"</em> option.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-mongodb-driver-bulkwrite.update-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1702">
<p><strong>Example #1 <span class="function"><strong>MongoDB\Driver\BulkWrite::update()</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 /></span><span style="color: #0000BB">$bulk</span><span style="color: #007700">-></span><span style="color: #0000BB">update</span><span style="color: #007700">(<br /> [</span><span style="color: #DD0000">'x' </span><span style="color: #007700">=> </span><span style="color: #0000BB">2</span><span style="color: #007700">],<br /> [</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: #DD0000">'multi' </span><span style="color: #007700">=> </span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #DD0000">'upsert' </span><span style="color: #007700">=> </span><span style="color: #0000BB">false</span><span style="color: #007700">]<br />);<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>
</div>
<div class="refsect1 seealso" id="refsect1-mongodb-driver-bulkwrite.update-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>
</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.insert.html">MongoDB\Driver\BulkWrite::insert</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.mongodb-driver-session.html">MongoDB\Driver\Session</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>
