Skip to content

CDRIVER-4309 document behavior for estimated_document_count #1001

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 1 commit into from
May 19, 2022
Merged

CDRIVER-4309 document behavior for estimated_document_count #1001

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions src/libmongoc/doc/mongoc_collection_estimated_document_count.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ This functions executes a count query on ``collection``. In contrast with :symbo

.. include:: includes/retryable-read.txt

Behavior
^^^^^^^^

This method is implemented using the `count <https://www.mongodb.com/docs/manual/reference/command/count/>`_ command. Due to an oversight in versions 5.0.0-5.0.8 of MongoDB, the ``count`` command was not included in version "1" of the Stable API. Applications using this method with the Stable API are recommended to upgrade their server version to 5.0.9+ or disable strict mode (via `:symbol:`mongoc_server_api_strict()`) to avoid encountering errors.

Errors
------

Expand Down Expand Up @@ -80,4 +85,5 @@ Example
.. seealso::

| :symbol:`mongoc_collection_count_documents()`
| `Count: Behavior <https://www.mongodb.com/docs/manual/reference/command/count/#behavior>`_ in the MongoDB Manual