Skip to content
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

DOCSP-47795 change batchsize descriptions #6292

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
12 changes: 9 additions & 3 deletions source/reference/command/find.txt
Original file line number Diff line number Diff line change
Expand Up @@ -132,9 +132,15 @@ The command accepts the following fields:

* - ``batchSize``
- non-negative integer
- Optional. The number of documents to return in the first batch.
Defaults to 101. A batchSize of 0 means that the cursor will be
established, but no documents will be returned in the first batch.
- Optional. The maximum number of documents that can be returned in each batch of a
query result. By default, the ``find`` command has an initial ``batchSize`` of
the lesser of ``101`` documents or 16 mebibytes (MiB) worth of documents.
Subsequent batches have a maximum size of 16 MiB. This option can enforce a smaller
limit than 16 MiB, but not a larger one. When set, the ``batchSize`` is the lesser
of ``batchSize`` documents or 16 MiB worth of documents.

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

Unlike the previous wire protocol version, a batchSize of 1 for
the :dbcommand:`find` command does not close the cursor.
Expand Down
8 changes: 4 additions & 4 deletions source/reference/command/getMore.txt
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,11 @@ The command accepts the following fields:

* - ``batchSize``
- positive integer
- Optional. The number of documents to return in the batch.
- Optional. The maximum number of documents that can be returned in each batch of a query result.

If ``batchSize`` is not set, ``getMore`` returns up to 16
mebibytes of data. If ``batchSize`` is set, ``getMore`` returns
the smaller of 16 mebibytes of data or ``batchSize`` documents.
If ``batchSize`` is not set, ``getMore`` returns up to 16 mebibytes (MiB) of data in all
subsequent batches. If ``batchSize`` is set, ``getMore`` returns
the lesser of ``batchSize`` documents or 16 MiB worth of documents.

* - ``maxTimeMS``
- non-negative integer
Expand Down
24 changes: 14 additions & 10 deletions source/reference/method/cursor.batchSize.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,14 @@ Definition

.. include:: /includes/fact-mongosh-shell-method.rst

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 :binary:`~bin.mongosh` and
most :driver:`drivers </>` return results as if MongoDB returned a
single batch.
The maximum number of documents that can be returned in each batch of a query result.
By default, the initial batch size is the lesser of ``101`` documents or 16 mebibytes (MiB) worth of
documents. Subsequent batches have a maximum size of 16 MiB. This option
can enforce a smaller limit than 16 MiB, but not a larger one. When set, the ``batchSize`` is the lesser
of ``batchSize`` documents or 16 MiB worth of documents.

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

.. note::

Expand All @@ -51,10 +53,12 @@ Definition

* - ``size``
- integer
- The initial number of documents to return for a batch. The
default initial batch size is 101 documents. Subsequent
batches are 16 mebibytes. The default applies to drivers and
Mongo Shell. For details, see :ref:`cursor-batches`.
- The maximum number of documents that can be returned in each batch of a query result. The
default initial batch size is the lesser or ``101`` documents or 16 mebibytes
(MiB) worth of documents. Subsequent batches have a maximum size of 16 MiB. This
option can enforce a smaller limit than 16 MiB, but not a larger one. The
default applies to drivers and Mongo Shell. For details, see
:ref:`cursor-batches`.

Compatibility
-------------
Expand Down
10 changes: 7 additions & 3 deletions source/reference/method/db.collection.watch.txt
Original file line number Diff line number Diff line change
Expand Up @@ -115,13 +115,17 @@ Definition
* - ``batchSize``

- int
- Optional. Specifies the maximum number of change events to return in each
batch of the response from the MongoDB cluster.
- Optional. The maximum number of documents that can be returned in each batch of
a change stream. By default, :method:`~db.collection.watch()` has an initial
batch size of the lesser of ``101`` documents or 16 mebibytes (MiB) worth of
documents. Subsequent batches have a maximum size of 16 mebibytes.This option
can enforce a smaller limit than 16 MiB, but not a larger one. When set, the
``batchSize`` is the lesser of ``batchSize`` documents or 16 MiB worth of
documents.

Has the same functionality as :method:`cursor.batchSize()`.



* - ``maxAwaitTimeMS``

- int
Expand Down
10 changes: 7 additions & 3 deletions source/reference/operator/aggregation/queryStats.txt
Original file line number Diff line number Diff line change
Expand Up @@ -354,9 +354,13 @@ Each document in the output array contains the following fields:
* - ``key.batchSize``
- String
- Normalized
- The :ref:`batch size <cursor-batchSize>` for the key. Batch size
specifies the number of documents to return in each batch of the
response from the MongoDB instance.
- The :ref:`batch size <cursor-batchSize>` for the key. Batch size
specifies the maximum number of documents that can be returned in each batch of a query
result. By default, the initial batch size is the lesser of ``101`` documents or 16
mebibytes (MiB) worth of documents. Subsequent batches have a maximum size of 16 MiB. ``batchSize`` can enforce a
smaller limit than 16 MiB, but not a larger one. When set, the
``batchSize`` is the lesser of ``batchSize`` documents or 16 MiB worth of
documents.

* - ``key.comment``
- String
Expand Down