cursor.batchSize()
On this page
Definition
cursor.batchSize(size)
Important
mongosh Method
This page documents a
mongosh
method. This is not the documentation for a language-specific driver, such as Node.js.For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.
Specifies the number of documents to return in each batch of the response from the MongoDB instance. In most cases, modifying the batch size will not affect the user or the application, as
mongosh
and most drivers return results as if MongoDB returned a single batch.The
batchSize()
method takes the following parameter:ParameterTypeDescriptionsize
integerThe number of documents to return per batch.
Example
The following example sets the batch size for the results of a query
(i.e. find()
) to 10
. The
batchSize()
method does not change the
output in mongosh
, which, by default, iterates over the
first 20 documents.
db.inventory.find().batchSize(10)