Skip to content

Commit 269819f

Browse files
committed
change based on feedback
1 parent a7bd71c commit 269819f

File tree

5 files changed

+36
-38
lines changed

5 files changed

+36
-38
lines changed

source/includes/extracts-watch-option.yaml

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
ref: watch-option-batchSize
22
content: |
3-
The maximum number of documents within each batch returned in a query result. By default,
4-
the ``find()`` method has an initial batch size of ``101`` documents
5-
and a maximum of 16 megabytes for each subsequent batch. This
6-
option can enforce a smaller limit than 16 megabytes, but not a larger
3+
The maximum number of documents within each batch returned in a query result, which applies
4+
to the ``aggregate`` command. By default, the ``aggregate`` command has an initial batch size of
5+
``101`` documents and a maximum size of 16 mebibytes for each subsequent batch. This
6+
option can enforce a smaller limit than 16 mebibytes, but not a larger
77
one. If you set ``batchSize`` to a limit that results in batches larger than
8-
16 MB, this option has no effect.
8+
16 MiB, this option has no effect.
99
10-
Irrespective of the ``batchSize`` option, the initial ``aggregate`` command
11-
response for a change stream generally does not include any documents
12-
unless another option is used to configure its starting point (e.g.
13-
``startAfter``).
10+
This command determines the maximum number of change events to return in each response from the
11+
server.
1412
---
1513
ref: watch-option-fullDocument
1614
content: |

source/read/retrieve.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -182,10 +182,10 @@ you can set in the array:
182182
* - ``batchSize``
183183
- | The maximum number of documents within each batch returned in a query result. By default,
184184
the ``find()`` method has an initial batch size of ``101`` documents
185-
and a maximum of 16 megabytes for each subsequent batch. This
186-
option can enforce a smaller limit than 16 megabytes, but not a larger
185+
and a maximum size of 16 mebibytes for each subsequent batch. This
186+
option can enforce a smaller limit than 16 mebibytes, but not a larger
187187
one. If you set ``batchSize`` to a limit that results in batches larger than
188-
16 MB, this option has no effect.
188+
16 MiB, this option has no effect.
189189
| **Type**: ``integer``
190190

191191
* - ``collation``

source/reference/method/MongoDBCollection-find.txt

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,16 @@ Parameters
5252

5353
* - batchSize
5454
- integer
55-
- The maximum number of documents within each batch returned in a query result. By default,
56-
the ``find()`` method has an initial batch size of ``101`` documents
57-
and a maximum of 16 megabytes for each subsequent batch. This
58-
option can enforce a smaller limit than 16 megabytes, but not a larger
55+
- The maximum number of documents within each batch returned in a query result, which applies
56+
to the ``aggregate`` command. By default, the ``aggregate`` command has an initial batch size of
57+
`101`` documents and a maximum size of 16 mebibytes for each subsequent batch. This
58+
option can enforce a smaller limit than 16 mebibytes, but not a larger
5959
one. If you set ``batchSize`` to a limit that results in batches larger than
60-
16 MB, this option has no effect.
60+
16 MiB, this option has no effect.
61+
62+
A batchSize of ``0`` means that the cursor will be established, but no documents
63+
will be returned in the first batch. This may be useful for quickly returning a cursor
64+
or failure from ``aggregate`` without doing significant server-side work.
6165

6266
Unlike the previous wire protocol version, a batchSize of ``1`` for the
6367
:dbcommand:`find` command does not close the cursor.

source/reference/method/MongoDBCollection-listSearchIndexes.txt

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,18 +40,16 @@ Parameters
4040

4141
* - batchSize
4242
- integer
43-
- The maximum number of documents within each batch returned in a query result. By default,
44-
the ``find()`` method has an initial batch size of ``101`` documents
45-
and a maximum of 16 megabytes for each subsequent batch. This
46-
option can enforce a smaller limit than 16 megabytes, but not a larger
43+
- The maximum number of documents within each batch returned in a query result, which applies
44+
to the ``aggregate`` command. By default, the ``aggregate`` command has an initial batch size of
45+
`101`` documents and a maximum size of 16 mebibytes for each subsequent batch. This
46+
option can enforce a smaller limit than 16 mebibytes, but not a larger
4747
one. If you set ``batchSize`` to a limit that results in batches larger than
48-
16 MB, this option has no effect.
48+
16 MiB, this option has no effect.
4949

50-
A batchSize of ``0`` is special in that and will only apply to the
51-
initial ``aggregate`` command; subsequent ``getMore`` commands will use
52-
the server's default batch size. This may be useful for quickly
53-
returning a cursor or failure from ``aggregate`` without doing
54-
significant server-side work.
50+
A batchSize of ``0`` means that the cursor will be established, but no documents
51+
will be returned in the first batch. This may be useful for quickly returning a cursor
52+
or failure from ``aggregate`` without doing significant server-side work.
5553

5654
* - codec
5755
- MongoDB\\Codec\\DocumentCodec

source/reference/method/MongoDBDatabase-aggregate.txt

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -54,18 +54,16 @@ Parameters
5454

5555
* - batchSize
5656
- integer
57-
- The maximum number of documents within each batch returned in a query result. By default,
58-
the ``find()`` method has an initial batch size of ``101`` documents
59-
and a maximum of 16 megabytes for each subsequent batch. This
60-
option can enforce a smaller limit than 16 megabytes, but not a larger
57+
- The maximum number of documents within each batch returned in a query result, which applies
58+
to the ``aggregate`` command. By default, the ``aggregate`` command has an initial batch size of
59+
`101`` documents and a maximum size of 16 mebibytes for each subsequent batch. This
60+
option can enforce a smaller limit than 16 mebibytes, but not a larger
6161
one. If you set ``batchSize`` to a limit that results in batches larger than
62-
16 MB, this option has no effect.
63-
64-
A batchSize of ``0`` is special in that and will only apply to the
65-
initial ``aggregate`` command; subsequent ``getMore`` commands will use
66-
the server's default batch size. This may be useful for quickly
67-
returning a cursor or failure from ``aggregate`` without doing
68-
significant server-side work.
62+
16 MiB, this option has no effect.
63+
64+
A batchSize of ``0`` means that the cursor will be established, but no documents
65+
will be returned in the first batch. This may be useful for quickly returning a cursor
66+
or failure from ``aggregate`` without doing significant server-side work.
6967

7068
* - bypassDocumentValidation
7169
- boolean

0 commit comments

Comments
 (0)