Skip to content

Commit 2703607

Browse files
DOCSP-47834 clarify batch size (#524) (#535)
* clarify batch size * change find * clarify no effect * fix wrapping * remove extra space * review (cherry picked from commit 9d38c02) Co-authored-by: shuangela <[email protected]>
1 parent 3380681 commit 2703607

File tree

2 files changed

+17
-4
lines changed

2 files changed

+17
-4
lines changed

source/fundamentals/crud/read-operations/change-streams.txt

+10-3
Original file line numberDiff line numberDiff line change
@@ -210,9 +210,16 @@ of ``Watch()`` and ``WatchAsync()``:
210210
include expanded events in a change stream, create the change stream
211211
cursor and set this parameter to ``True``.
212212

213-
* - ``BatchSize``
214-
- | Specifies the maximum number of change events to return in each batch of the
215-
response from the MongoDB cluster.
213+
* - ``batchSize``
214+
- | Specifies the maximum number of documents that a change
215+
stream can return in each batch, which applies to ``Watch()`` or
216+
``WatchAsync()``. If the ``batchSize`` option is not set, watch functions have an
217+
initial batch size of ``101`` documents and a maximum size of 16 mebibytes (MiB)
218+
for each subsequent batch. This option can
219+
enforce a smaller limit than 16 MiB, but not a larger one. If
220+
you set ``batchSize`` to a limit that result in batches
221+
larger than 16 MiB, this option has no effect and ``Watch()``
222+
or ``WatchAsync()`` uses the default batch size.
216223

217224
* - ``Collation``
218225
- | Specifies the collation to use for the change stream cursor.

source/fundamentals/crud/read-operations/retrieve.txt

+7-1
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,13 @@ You can configure the commonly used options with the following methods:
205205
- Description
206206

207207
* - ``BatchSize``
208-
- | Gets or sets the number of documents to hold in a cursor at a given time.
208+
- | Gets or sets the maximum number of documents within each
209+
batch returned in a query result. If ``batchSize`` is not set, the ``Find()``
210+
method has an initial batch size of ``101`` documents and a maximum size of 16
211+
mebibytes (MiB) for each subsequent batch. This option can enforce a smaller
212+
limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that
213+
results in batches larger than 16 MiB, this option has no effect and the
214+
``Find()`` method uses the default batch size.
209215

210216
* - ``Collation``
211217
- | Sets the collation options.

0 commit comments

Comments
 (0)