<!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>Limits the number of elements returned in one batch</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.mongocursorinterface.html">MongoCursorInterface</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongocursorinterface.dead.html">MongoCursorInterface::dead</a></div>
<div class="up"><a href="class.mongocursorinterface.html">MongoCursorInterface</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongocursorinterface.batchsize" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoCursorInterface::batchSize</h1>
<p class="verinfo">(PECL mongo >=1.5.0)</p><p class="refpurpose"><span class="refname">MongoCursorInterface::batchSize</span> — <span class="dc-title">Limits the number of elements returned in one batch</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongocursorinterface.batchsize-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type"><a href="class.mongocursorinterface.html" class="type MongoCursorInterface">MongoCursorInterface</a></span> <span class="methodname"><strong>MongoCursorInterface::batchSize</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$batchSize</code></span>
)</div>
<p class="para rdfs-comment">
A cursor typically fetches a batch of result objects and stores them
locally. This method sets the batch size value to configure the amount of
documents retrieved from the server in one round trip.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mongocursorinterface.batchsize-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">batchSize</code>
</dt>
<dd>
<p class="para">
The number of results to return per batch.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongocursorinterface.batchsize-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns this cursor.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.mongocursorinterface.html">MongoCursorInterface</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongocursorinterface.dead.html">MongoCursorInterface::dead</a></div>
<div class="up"><a href="class.mongocursorinterface.html">MongoCursorInterface</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
