<!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>Limit number of modified documents</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mysql-xdevapi-collectionmodify.execute.html">CollectionModify::execute</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-collectionmodify.patch.html">CollectionModify::patch</a></div>
<div class="up"><a href="class.mysql-xdevapi-collectionmodify.html">mysql_xdevapi\CollectionModify</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mysql-xdevapi-collectionmodify.limit" class="refentry">
<div class="refnamediv">
<h1 class="refname">CollectionModify::limit</h1>
<p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">CollectionModify::limit</span> — <span class="dc-title">Limit number of modified documents</span></p>
</div>
<div class="refsect1 description" id="refsect1-mysql-xdevapi-collectionmodify.limit-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\CollectionModify::limit</strong></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$rows</code></span>
)</div>
<p class="para rdfs-comment">
Limit the number of documents modified by this operation.
Optionally combine with skip() to define an offset value.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mysql-xdevapi-collectionmodify.limit-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">rows</code></dt>
<dd>
<p class="para">
The maximum number of documents to modify.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-mysql-xdevapi-collectionmodify.limit-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A CollectionModify object.
</p>
</div>
<div class="refsect1 examples" id="refsect1-mysql-xdevapi-collectionmodify.limit-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-2013">
<p><strong>Example #1 <span class="function"><strong>mysql_xdevapi\CollectionModify::limit()</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 /></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": "Fred", "age": 21, "job": "Construction"}'</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": "Wilma", "age": 23, "job": "Teacher"}'</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": "Betty", "age": 24, "job": "Teacher"}'</span><span style="color: #007700">)-></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><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 = :job"</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">bind</span><span style="color: #007700">([</span><span style="color: #DD0000">'job' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'Teacher'</span><span style="color: #007700">])<br /> -></span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #DD0000">'job'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Principal'</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">limit</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$collection<br /> </span><span style="color: #007700">-></span><span style="color: #0000BB">find</span><span style="color: #007700">()<br /> -></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">-></span><span style="color: #0000BB">fetchAll</span><span style="color: #007700">());<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
(
[0] => Array
(
[_id] => 00005b6b53610000000000000118
[age] => 21
[job] => Construction
[name] => Fred
)
[1] => Array
(
[_id] => 00005b6b53610000000000000119
[age] => 23
[job] => Principal
[name] => Wilma
)
[2] => Array
(
[_id] => 00005b6b5361000000000000011a
[age] => 24
[job] => Teacher
[name] => Betty
)
)
</pre></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-collectionmodify.execute.html">CollectionModify::execute</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-collectionmodify.patch.html">CollectionModify::patch</a></div>
<div class="up"><a href="class.mysql-xdevapi-collectionmodify.html">mysql_xdevapi\CollectionModify</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
