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.

Sign up for GitHub

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 9 commits into from
Apr 8, 2025
Merged

[DOCSP-47795] Change batchsize description #392

Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
54bb7aa
change batchsize description
shuangela Mar 14, 2025
e2b0108
address feedback
shuangela Mar 14, 2025
ff14d5a
remove period
shuangela Mar 14, 2025
7ffadcd
remove typo
shuangela Mar 14, 2025
4c11fab
fix wrap
shuangela Mar 14, 2025
3b21613
wrap
shuangela Mar 14, 2025
f538eb7
ch feedback
shuangela Apr 3, 2025
6d851eb
ch feedback
shuangela Apr 8, 2025
fa0495d
fix spacing
shuangela Apr 8, 2025
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
13 changes: 11 additions & 2 deletions source/reference/methods.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -497,8 +497,17 @@ 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
Copy link

Choose a reason for hiding this comment

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

How about "can" instead of will? Feels like it aligns better with the interaction with the concurrent size limit

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

Choose a reason for hiding this comment

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

'default batch size' here feels... undefined? In general I liked the wording in the other PR about how the batch sizes end up being 'the lesser of the two'


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