<!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>Modify collection documents</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mysql-xdevapi-collection.getsession.html">Collection::getSession</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-collection.remove.html">Collection::remove</a></div>
<div class="up"><a href="class.mysql-xdevapi-collection.html">mysql_xdevapi\Collection</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mysql-xdevapi-collection.modify" class="refentry">
<div class="refnamediv">
<h1 class="refname">Collection::modify</h1>
<p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">Collection::modify</span> — <span class="dc-title">Modify collection documents</span></p>
</div>
<div class="refsect1 description" id="refsect1-mysql-xdevapi-collection.modify-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type mysql_xdevapi\CollectionModify">mysql_xdevapi\CollectionModify</span></span> <span class="methodname"><strong>mysql_xdevapi\Collection::modify</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$search_condition</code></span>
)</div>
<p class="para rdfs-comment">
Modify collections that meet specific search conditions.
Multiple operations are allowed, and parameter binding
is supported.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mysql-xdevapi-collection.modify-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">search_condition</code></dt>
<dd>
<p class="para">
Must be a valid SQL expression used to match the documents to modify.
This expression might be as simple as <strong><code>TRUE</code></strong>, which matches all
documents, or it might use functions and operators such as
<code class="code">'CAST(_id AS SIGNED) >= 10'</code>,
<code class="code">'age MOD 2 = 0 OR age MOD 3 = 0'</code>, or
<code class="code">'_id IN ["2","5","7","10"]'</code>.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-mysql-xdevapi-collection.modify-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
If the operation is not executed, then the function will return
a Modify object that can be used to add additional
modify operations.
</p>
<p class="para">
If the modify operation is executed, then the returned object will contain
the result of the operation.
</p>
</div>
<div class="refsect1 examples" id="refsect1-mysql-xdevapi-collection.modify-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1991">
<p><strong>Example #1 <span class="function"><strong>mysql_xdevapi\Collection::modify()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$session </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_xdevapi</span><span style="color: #007700">\</span><span style="color: #0000BB">getSession</span><span style="color: #007700">(</span><span style="color: #DD0000">"mysqlx://user:password@localhost"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-></span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"DROP DATABASE IF EXISTS addressbook"</span><span style="color: #007700">)-></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-></span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"CREATE DATABASE addressbook"</span><span style="color: #007700">)-></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$schema </span><span style="color: #007700">= </span><span style="color: #0000BB">$session</span><span style="color: #007700">-></span><span style="color: #0000BB">getSchema</span><span style="color: #007700">(</span><span style="color: #DD0000">"addressbook"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$collection </span><span style="color: #007700">= </span><span style="color: #0000BB">$schema</span><span style="color: #007700">-></span><span style="color: #0000BB">createCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"people"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$collection</span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">'{"name": "Alfred", "age": 18, "job": "Butler"}'</span><span style="color: #007700">)-></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$collection</span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">'{"name": "Bob", "age": 19, "job": "Painter"}'</span><span style="color: #007700">)-></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// Add two new jobs for all Painters: Artist and Crafter<br /></span><span style="color: #0000BB">$collection<br /> </span><span style="color: #007700">-></span><span style="color: #0000BB">modify</span><span style="color: #007700">(</span><span style="color: #DD0000">"job in ('Butler', 'Painter')"</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">arrayAppend</span><span style="color: #007700">(</span><span style="color: #DD0000">'job'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Artist'</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">arrayAppend</span><span style="color: #007700">(</span><span style="color: #DD0000">'job'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Crafter'</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// Remove the 'beer' field from all documents with the age 21<br /></span><span style="color: #0000BB">$collection<br /> </span><span style="color: #007700">-></span><span style="color: #0000BB">modify</span><span style="color: #007700">(</span><span style="color: #DD0000">'age < 21'</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">unset</span><span style="color: #007700">([</span><span style="color: #DD0000">'beer'</span><span style="color: #007700">])<br /> -></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mysql-xdevapi-collection.getsession.html">Collection::getSession</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-collection.remove.html">Collection::remove</a></div>
<div class="up"><a href="class.mysql-xdevapi-collection.html">mysql_xdevapi\Collection</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
