Skip to content

Commit 22a8696

Browse files
authored
CDRIVER-4309 document behavior for estimated_document_count (#1001)
1 parent 17827e3 commit 22a8696

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/libmongoc/doc/mongoc_collection_estimated_document_count.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ This functions executes a count query on ``collection``. In contrast with :symbo
4040

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

43+
Behavior
44+
^^^^^^^^
45+
46+
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.
47+
4348
Errors
4449
------
4550

@@ -80,4 +85,5 @@ Example
8085
.. seealso::
8186

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

0 commit comments

Comments
 (0)