DOCSP-49975 Specify Documents to Return #503
Conversation
✅ Deploy Preview for docs-golang ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| sort fields and direction to the ``SetSort()`` method of an operation's options. | ||
|
|
||
| The following operations take options as a parameter: |
There was a problem hiding this comment.
| The following operations take options as a parameter: | |
| The following operations take sort options as a parameter: |
| the read operation's options. | ||
|
|
||
| The following read operations take an options object as a parameter: |
There was a problem hiding this comment.
| The following read operations take an options object as a parameter: | |
| The following read operations take skip options as a parameter: |
|
|
||
| Passing in a negative number to the ``SetSkip()`` method results | ||
| in a runtime error. |
There was a problem hiding this comment.
This is funny to imagine someone attempting to skip negative documents – do you feel this is worth specifically calling out or can we trim this out?
| opts := options.Find().SetLimit(2).SetSort(bson.D{{"enrollment", -1}}).SetSkip(1) | ||
| opts := options.Find().SetLimit(2).SetSkip(1).SetSort(bson.D{{"enrollment", -1}}) | ||
| opts := options.Find().SetSkip(1).SetSort(bson.D{{"enrollment", -1}}).SetLimit(2) | ||
| opts := options.Find().SetSkip(1).SetLimit(2).SetSort(bson.D{{"enrollment", -1}}) |
There was a problem hiding this comment.
Not sure I'm a fan of having the code block inside the admonition here – could we either take this out of the admonition or reword this to say "Performing the limit, sort, and skip options in any order will produce the same result"?
There was a problem hiding this comment.
Edited and moved the example to the top of the section! Order matters for sort and skip.
| ~~~~~~~~~~~~~ | ||
|
|
||
| A tie occurs when two or more documents have identical values in the | ||
| field you are using to sort your results. MongoDB does not guarantee | ||
| order if ties occur. | ||
|
|
||
| For example, in the sample data, there is a tie for ``enrollment`` in | ||
| the following documents: | ||
|
|
||
| .. code-block:: none | ||
| :copyable: false | ||
|
|
||
| {"title":"World Fiction","enrollment":35} | ||
| {"title":"Plate Tectonics","enrollment":35} | ||
|
|
||
| You can sort on additional fields to resolve ties in the original sort. | ||
| If you want to guarantee a specific order for documents, select sort fields | ||
| that do not result in ties. |
There was a problem hiding this comment.
Given that this section doesn't discuss Go-specific implementation details, I think instead of this section we can have something like "To learn more about sort behavior, see the cursor.sort() documentation in the {+mdb-server+} manual"
There was a problem hiding this comment.
I looked at the linked page, and the page does not explicitly mention handling ties. I also don't want to confuse the reader since the cursor.sort() syntax is slightly different. For these reasons, I'll leave as is!
Pull Request Info
Moves info from relevant pages onto one page.
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-49975
Staging Links
https://deploy-preview-503--docs-golang.netlify.app/crud/query/specify-return-documents/
Self-Review Checklist