cursor.batchSize()

Definition

cursor.batchSize(size)

Important

mongosh Method

This is a mongosh method. This is not the documentation for Node.js or other programming language specific driver methods.

In most cases, mongosh methods work the same way as the legacy mongo shell methods. However, some legacy methods are unavailable in mongosh.

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

• mongo shell v4.4

• mongo shell v4.2

• mongo shell v4.0

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.

Note

If the batch size is too large, the cursor allocates more resources than it requires, which can negatively impact query performance. If the batch size is too small, the cursor requires more network round trips to retrieve the query results, which can negatively impact query performance.

Adjust batchSize to a value appropriate to your database, load, and application needs.

The batchSize() method takes the following field:

Field	Type	Description
size	integer	The initial number of documents to return for a batch. The default initial batch size is 101 documents. Subsequent batches are 16 megabytes. The default applies to drivers and Mongo Shell. For details, see Cursor Batches.

Compatibility

This method is available in deployments hosted in the following environments:

• MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

• MongoDB Enterprise: The subscription-based, self-managed version of MongoDB

• MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB

Example

The following example sets batchSize for the results of a query (specifically, find()) to 10:

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

Learn More

• Cursor Batches

• cursor.next()

• getMore