Skip to content

[DOCSP-47795] Change batchsize description #392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions source/reference/methods.txt
Original file line number Diff line number Diff line change
Expand Up @@ -497,8 +497,15 @@ Cursor Methods
.. arrayAccess

* - :method:`cursor.batchSize()`
- Controls the number of documents MongoDB will return to the
client in a single network message.
- Specifies the maximum number of documents MongoDB will return to the client
within each batch returned in a query result. By default, the initial batch
size is ``101`` documents and subsequent batches have a maximum
size of 16 mebibytes (MiB). This option can enforce a smaller
limit than 16 MiB, but not a larger one. If you set ``batchSize``
to a limit that results in batches larger than 16 MiB, this option has no effect and :method:`~cursor.batchSize()` uses the default batch size.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nit]

Would you mind wrapping this line at col 72? Thanks!


A ``batchSize`` of ``0`` means that the cursor is established, but no documents
are returned in the first batch.

The following example query returns results in batches of
100:
Expand Down