cursor.batchSize()¶

On this page

Definition
Example

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 :driver:`MongoDB driver documentation </>`.

For the legacy mongo shell documentation, refer to the documentation for the corresponding MongoDB Server release:

:v4.4:`mongo shell v4.4 </mongo>`
mongo shell v4.2

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 :driver:`drivers </>` return results as if MongoDB returned a single batch.

The batchSize() method takes the following parameter:

Parameter	Type	Description
`size`	integer	The number of documents to return per batch. Do not use a batch size of `1`.

Note

Specifying 1 or a negative number is analogous to using the limit() method.

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.

copy

db.inventory.find().batchSize(10)

← cursor.allowPartialResults() cursor.close() →