DOCSP-40800: Specify documents to return #24
Conversation
| } | ||
|
|
||
| { | ||
| // Retrieves 5 matching documents, skips the first 10 results, and sorts by ascending "name" order |
There was a problem hiding this comment.
S: In the comment, add that the documents have a "cuisine" value of "Italian" to match previous comments
|
|
||
| The examples in this guide use the ``restaurants`` collection in the ``sample_restaurants`` | ||
| database from the :atlas:`Atlas sample datasets </sample-data>`. To access this collection | ||
| from your C++ application, instantiate a ``client`` that connects to an Atlas cluster |
There was a problem hiding this comment.
| from your C++ application, instantiate a ``client`` that connects to an Atlas cluster | |
| from your C++ application, instantiate a `` mongocxx::client`` that connects to an Atlas cluster |
Q: Should client be changed to mongocxx::client?
|
|
||
| To specify the maximum number of documents returned from a read operation, create | ||
| an instance of the ``mongocxx::options::find`` class and set its ``limit`` field. | ||
| Then, pass your ``mongocxx::options::find`` instance as a parameter to the |
There was a problem hiding this comment.
nit: change parameter to argument
applies to all
| The preceding example returns the first five documents matched by the query | ||
| according to their :manual:`natural order </reference/glossary/#std-term-natural-order>` | ||
| in the database. The following section describes how to return the documents | ||
| in a specified sort order. |
There was a problem hiding this comment.
nit: specified order rather than specified sort order
| parameter to the ``find()`` method. | ||
|
|
||
|
|
||
| To set the ``sort`` field, call the ``sort()`` setter method on your ``mongocxx::options::find`` |
There was a problem hiding this comment.
Q: You used "setter method" here when you did not use it above (the limit() function). Is there a difference between these two?
There was a problem hiding this comment.
Based on the API docs, seems like the find() method and limit() are the same type of method, so adding setter might not clarify/help this sentence.
There was a problem hiding this comment.
sort() and limit() are setter methods, since they set fields of a mongocxx::options::find object; find() is not. But I can remove the word "setter" here if it's confusing
| number of sorted documents to return, skipping a specified number of | ||
| documents before returning. | ||
|
|
||
| The following example returns documents that have a ``cuisine`` value of |
There was a problem hiding this comment.
| The following example returns documents that have a ``cuisine`` value of | |
| The following example returns ``5`` documents that have a ``cuisine`` value of |
| documents before returning. | ||
|
|
||
| The following example returns documents that have a ``cuisine`` value of | ||
| ``"Italian"``. The results are sorted in ascending ``name`` value order, |
There was a problem hiding this comment.
| ``"Italian"``. The results are sorted in ascending ``name`` value order, | |
| ``"Italian"``. The results are sorted in ascending order by ``name`` field value, |
|
|
||
| The order in which you call these methods doesn't change the documents | ||
| that are returned. The driver automatically reorders the calls to perform the | ||
| sort and skip operations first, and the limit operation afterward. |
There was a problem hiding this comment.
Question: Do sort and skip happen at the same time? Which one happens first relative to the other? I think that the order they happen in would change the results of the operation.
There was a problem hiding this comment.
Sort happens first, then skip!
|
|
||
| To learn more about any of the methods or types discussed in this | ||
| guide, see the following API documentation: | ||
|
|
There was a problem hiding this comment.
| - `mongocxx::options::find <{+api+}/classmongocxx_1_1v__noabi_1_1options_1_1find.html>`__ |
| To learn more about any of the methods or types discussed in this | ||
| guide, see the following API documentation: | ||
|
|
||
| - `find() <{+api+}/classmongocxx_1_1v__noabi_1_1collection.html#ada76e1596a65c7615e7af7d34a8140d6>`__ |
There was a problem hiding this comment.
S: add full namespace (mongocxx::...) to all the methods
applies to all
…P-40800-limit-sort-skip
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-40800
Staging - https://preview-mongodbnorareidy.gatsbyjs.io/cpp-driver/DOCSP-40800-limit-sort-skip/read/specify-documents-to-return/
This PR also adds code comments to the
retrieve.cppfile.Self-Review Checklist