DOCSP-48708 Specify cursor limitations by lindseymoore · Pull Request #1094 · mongodb/docs-node

lindseymoore · 2025-04-22T20:17:42Z

Pull Request Info

Adds note about chaining cursor methods before iterating cursor. Also, edits examples on Find page to standardize using cursor chaining rather than passing cursor methods as options.

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-48708

Staging Links

https://deploy-preview-1094--docs-node.netlify.app/crud/query/retrieve/

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?
Are the facets and meta keywords accurate?
Are the page titles greater than 20 characters long and SEO relevant?

netlify · 2025-04-22T20:18:03Z

✅ Deploy Preview for docs-node ready!

Name	Link
🔨 Latest commit	`ab47f48`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-node/deploys/6808ffe45cc8f90007c49a82
😎 Deploy Preview	https://deploy-preview-1094--docs-node.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

lindseymoore · 2025-04-22T21:08:14Z

For technical reviewer: Can cursor chaining be used for findOne? Tried to chain for the findOne example on the page, but I got a TypeError: movies.findOne(...).sort is not a function error. It seems like findOne doesn't return a cursor but want to check anyways if it's an option to chain. Thanks!

You are correct that findOne cannot be chained as it is immediately exhausting the cursor and returning a Promise<Document> not a cursor.

stephmarie17

LGTM just a couple of suggestions

stephmarie17 · 2025-04-22T22:26:40Z

-      // Include only the `title` and `imdb` fields in each returned document
-      projection: { _id: 0, title: 1, imdb: 1 },
-    };
+    const sort = { title: 1 };


[s] I wonder of naming this sortOptions or sortOpts would be clearer?

Good suggestion, I think naming it sortFields can make this more clear.

stephmarie17 · 2025-04-22T22:33:21Z

 For more projection examples, see the
 :manual:`MongoDB Manual page on Project Fields to Return from Query </tutorial/project-fields-from-query-results/>`.
+
+.. note::


[s] What do you think of making this an include instead?

Made an include called chain-cursor-methods.rst

* DOCSP-48708 Specify cursor limitations * add chaining method to find * edit * edit find ts example * SA review * change cursor chain const names to be more specific

* DOCSP-48375 ToC reorg part one (#1035) * DOCSP-48376: Get Started edits (#1039) * DOCSP-48376: Get Started edits * edits * RR feedback * DOCSP-48384: Atlas search (#1041) * DOCSP-48384: Atlas search * edits * tech feedback * DOCSP-48378 make mongoclient page (#1038) * make mongoclient page * fix link: * fix link * add anchor to page to avoid broken link * nr feedback * nb feedback * monospace * DOCSP-48383 document bson (#1044) * make bson page * edit code * fix spacing * capitalization * change copy * nb edits * DOCSP-48493: Databases & collections (#1045) * DOCSP-48493: Databases & collections * edits * SA feedback * typo * DOCSP-48385 Make Atlas Vector Search page (#1042) * make page * fix vale * remove extra space * add to index * fix link * fix link * fix quotes * fix quotes * lm feedback * fix spacing * remove extra code * fix spacing * fix link * fix link title * change copy * lm review * change spacing * lm edits * remove extra words * nb edits * remove extra quotes * fix quotes * add quote * change quote * nb feedback * DOCSP-48377 Authentication Reorg (#1040) * DOCSP-48377 Authentication Reorg * start building TOC * full draft * edits * edits * SA comments * SA update redirect * Edit table * DOCSP-48379 Connection Targets (#1043) * DOCSP-48379 Connection Targets * edits * edits * last edits * one more * ignoring vale check * eol for file * NR review * vale check * DOCSP-48381 make specify docs page (#1037) * make specify docs page * fix includes link * fix link * fix highlighting and links * remove passive * nr feedback * final edits * fix typo * nr feedback * tech review * fix wording * Fix spacing * spacing change * Update connection-targets.txt * Update access-cursor-note.rst * Update access-cursor-note.rst * DOCSP-48388 break up faq (#1048) * break up faq * vale errors * fix vale error * wording * add redirect * remove faq * change headlines * js feedback * bp edits * bp feedback * DOCSP-48592 Security Landing Page (#1064) * DOCSP-48592 Security Landing Page * remove sample app * change title * DOCSP-48608 Edit AVS and AS section on Indexes page (#1065) * DOCSP-48606 Atlas Vector Search * edit existing sections * Edits * edit code comments * add link to as query guide * title change * more edits * DOCSP-48382: Configure CRUD operations (#1049) * DOCSP-48382: Configure CRUD operations * edits, move info * edits * AS feedback * tech feedback * DOCSP-48386 Add monitoring page (#1046) * DOCSP-48683 Refine Connection Pools page (#1067) * DOCSP-48501 add casual consistency section (#1047) * add casual consistency section: * change find to findone * DOCSP-49031 UUID (#1072) * DOCSP-48717 UUID * DOCSP-49031 UUID * edits * edit import * edit * edit * JS review * tech review * DOCSP-48390 Document Data Formats: EJSON (#1069) * DOCSP-48390 Document Data Formats: EJSON * add to toc and bson import note * edit * add binary type * edit ouputs * remove additional info section * last small edits * fix link * edit * tech review * edits * tech review 2 * add note about bad orange highlighting * tech review * DOCSP-48487 Move usage examples (#1071) * DOCSP-48389 Connection Troubleshooting Revisions (#1068) * DOCSP-48389 Connection Troubleshooting Revisions * tech question * edits * tech review * edit * remov * technical review * security comment * JS review * edit * DOCSP-48707 Standardize cursor chaining methods (#1073) * DOCSP-48707 Standardize cursor chaining methods * tech review * edits * vale check * remove mention of options object * order comment * RR review * DOCSP-48708 Specify cursor limitations (#1094) * DOCSP-48708 Specify cursor limitations * add chaining method to find * edit * edit find ts example * SA review * change cursor chain const names to be more specific * DOCSP-48497 Comp cov clean up (#1095) * add back old refs * get started --------- Co-authored-by: Stephanie <52582720+stephmarie17@users.noreply.github.com> Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: shuangela <angela.shu@mongodb.com>

* DOCSP-48375 ToC reorg part one (mongodb#1035) * DOCSP-48376: Get Started edits (mongodb#1039) * DOCSP-48376: Get Started edits * edits * RR feedback * DOCSP-48384: Atlas search (mongodb#1041) * DOCSP-48384: Atlas search * edits * tech feedback * DOCSP-48378 make mongoclient page (mongodb#1038) * make mongoclient page * fix link: * fix link * add anchor to page to avoid broken link * nr feedback * nb feedback * monospace * DOCSP-48383 document bson (mongodb#1044) * make bson page * edit code * fix spacing * capitalization * change copy * nb edits * DOCSP-48493: Databases & collections (mongodb#1045) * DOCSP-48493: Databases & collections * edits * SA feedback * typo * DOCSP-48385 Make Atlas Vector Search page (mongodb#1042) * make page * fix vale * remove extra space * add to index * fix link * fix link * fix quotes * fix quotes * lm feedback * fix spacing * remove extra code * fix spacing * fix link * fix link title * change copy * lm review * change spacing * lm edits * remove extra words * nb edits * remove extra quotes * fix quotes * add quote * change quote * nb feedback * DOCSP-48377 Authentication Reorg (mongodb#1040) * DOCSP-48377 Authentication Reorg * start building TOC * full draft * edits * edits * SA comments * SA update redirect * Edit table * DOCSP-48379 Connection Targets (mongodb#1043) * DOCSP-48379 Connection Targets * edits * edits * last edits * one more * ignoring vale check * eol for file * NR review * vale check * DOCSP-48381 make specify docs page (mongodb#1037) * make specify docs page * fix includes link * fix link * fix highlighting and links * remove passive * nr feedback * final edits * fix typo * nr feedback * tech review * fix wording * Fix spacing * spacing change * Update connection-targets.txt * Update access-cursor-note.rst * Update access-cursor-note.rst * DOCSP-48388 break up faq (mongodb#1048) * break up faq * vale errors * fix vale error * wording * add redirect * remove faq * change headlines * js feedback * bp edits * bp feedback * DOCSP-48592 Security Landing Page (mongodb#1064) * DOCSP-48592 Security Landing Page * remove sample app * change title * DOCSP-48608 Edit AVS and AS section on Indexes page (mongodb#1065) * DOCSP-48606 Atlas Vector Search * edit existing sections * Edits * edit code comments * add link to as query guide * title change * more edits * DOCSP-48382: Configure CRUD operations (mongodb#1049) * DOCSP-48382: Configure CRUD operations * edits, move info * edits * AS feedback * tech feedback * DOCSP-48386 Add monitoring page (mongodb#1046) * DOCSP-48683 Refine Connection Pools page (mongodb#1067) * DOCSP-48501 add casual consistency section (mongodb#1047) * add casual consistency section: * change find to findone * DOCSP-49031 UUID (mongodb#1072) * DOCSP-48717 UUID * DOCSP-49031 UUID * edits * edit import * edit * edit * JS review * tech review * DOCSP-48390 Document Data Formats: EJSON (mongodb#1069) * DOCSP-48390 Document Data Formats: EJSON * add to toc and bson import note * edit * add binary type * edit ouputs * remove additional info section * last small edits * fix link * edit * tech review * edits * tech review 2 * add note about bad orange highlighting * tech review * DOCSP-48487 Move usage examples (mongodb#1071) * DOCSP-48389 Connection Troubleshooting Revisions (mongodb#1068) * DOCSP-48389 Connection Troubleshooting Revisions * tech question * edits * tech review * edit * remov * technical review * security comment * JS review * edit * DOCSP-48707 Standardize cursor chaining methods (mongodb#1073) * DOCSP-48707 Standardize cursor chaining methods * tech review * edits * vale check * remove mention of options object * order comment * RR review * DOCSP-48708 Specify cursor limitations (mongodb#1094) * DOCSP-48708 Specify cursor limitations * add chaining method to find * edit * edit find ts example * SA review * change cursor chain const names to be more specific * DOCSP-48497 Comp cov clean up (mongodb#1095) * add back old refs * get started --------- Co-authored-by: Stephanie <52582720+stephmarie17@users.noreply.github.com> Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: shuangela <angela.shu@mongodb.com> (cherry picked from commit 1e62fc0)

* Node CC merge comp-cov branch (#1096) * DOCSP-48375 ToC reorg part one (#1035) * DOCSP-48376: Get Started edits (#1039) * DOCSP-48376: Get Started edits * edits * RR feedback * DOCSP-48384: Atlas search (#1041) * DOCSP-48384: Atlas search * edits * tech feedback * DOCSP-48378 make mongoclient page (#1038) * make mongoclient page * fix link: * fix link * add anchor to page to avoid broken link * nr feedback * nb feedback * monospace * DOCSP-48383 document bson (#1044) * make bson page * edit code * fix spacing * capitalization * change copy * nb edits * DOCSP-48493: Databases & collections (#1045) * DOCSP-48493: Databases & collections * edits * SA feedback * typo * DOCSP-48385 Make Atlas Vector Search page (#1042) * make page * fix vale * remove extra space * add to index * fix link * fix link * fix quotes * fix quotes * lm feedback * fix spacing * remove extra code * fix spacing * fix link * fix link title * change copy * lm review * change spacing * lm edits * remove extra words * nb edits * remove extra quotes * fix quotes * add quote * change quote * nb feedback * DOCSP-48377 Authentication Reorg (#1040) * DOCSP-48377 Authentication Reorg * start building TOC * full draft * edits * edits * SA comments * SA update redirect * Edit table * DOCSP-48379 Connection Targets (#1043) * DOCSP-48379 Connection Targets * edits * edits * last edits * one more * ignoring vale check * eol for file * NR review * vale check * DOCSP-48381 make specify docs page (#1037) * make specify docs page * fix includes link * fix link * fix highlighting and links * remove passive * nr feedback * final edits * fix typo * nr feedback * tech review * fix wording * Fix spacing * spacing change * Update connection-targets.txt * Update access-cursor-note.rst * Update access-cursor-note.rst * DOCSP-48388 break up faq (#1048) * break up faq * vale errors * fix vale error * wording * add redirect * remove faq * change headlines * js feedback * bp edits * bp feedback * DOCSP-48592 Security Landing Page (#1064) * DOCSP-48592 Security Landing Page * remove sample app * change title * DOCSP-48608 Edit AVS and AS section on Indexes page (#1065) * DOCSP-48606 Atlas Vector Search * edit existing sections * Edits * edit code comments * add link to as query guide * title change * more edits * DOCSP-48382: Configure CRUD operations (#1049) * DOCSP-48382: Configure CRUD operations * edits, move info * edits * AS feedback * tech feedback * DOCSP-48386 Add monitoring page (#1046) * DOCSP-48683 Refine Connection Pools page (#1067) * DOCSP-48501 add casual consistency section (#1047) * add casual consistency section: * change find to findone * DOCSP-49031 UUID (#1072) * DOCSP-48717 UUID * DOCSP-49031 UUID * edits * edit import * edit * edit * JS review * tech review * DOCSP-48390 Document Data Formats: EJSON (#1069) * DOCSP-48390 Document Data Formats: EJSON * add to toc and bson import note * edit * add binary type * edit ouputs * remove additional info section * last small edits * fix link * edit * tech review * edits * tech review 2 * add note about bad orange highlighting * tech review * DOCSP-48487 Move usage examples (#1071) * DOCSP-48389 Connection Troubleshooting Revisions (#1068) * DOCSP-48389 Connection Troubleshooting Revisions * tech question * edits * tech review * edit * remov * technical review * security comment * JS review * edit * DOCSP-48707 Standardize cursor chaining methods (#1073) * DOCSP-48707 Standardize cursor chaining methods * tech review * edits * vale check * remove mention of options object * order comment * RR review * DOCSP-48708 Specify cursor limitations (#1094) * DOCSP-48708 Specify cursor limitations * add chaining method to find * edit * edit find ts example * SA review * change cursor chain const names to be more specific * DOCSP-48497 Comp cov clean up (#1095) * add back old refs * get started --------- Co-authored-by: Stephanie <52582720+stephmarie17@users.noreply.github.com> Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: shuangela <angela.shu@mongodb.com> (cherry picked from commit 1e62fc0) * Backport v6.16 NodeCC * fix redirect --------- Co-authored-by: Stephanie <52582720+stephmarie17@users.noreply.github.com> Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: shuangela <angela.shu@mongodb.com>

DOCSP-48708 Specify cursor limitations

3872ed4

lindseymoore added 3 commits April 22, 2025 16:56

add chaining method to find

1261365

edit

eeb95c1

edit find ts example

83a9f44

lindseymoore commented Apr 22, 2025

View reviewed changes

stephmarie17 approved these changes Apr 22, 2025

View reviewed changes

lindseymoore added 2 commits April 23, 2025 10:49

SA review

e26cd4c

change cursor chain const names to be more specific

ab47f48

durran approved these changes Apr 23, 2025

View reviewed changes

lindseymoore merged commit 6171f79 into mongodb:comp-cov Apr 23, 2025
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCSP-48708 Specify cursor limitations#1094

DOCSP-48708 Specify cursor limitations#1094
lindseymoore merged 6 commits into
mongodb:comp-covfrom
lindseymoore:DOCSP-48708

lindseymoore commented Apr 22, 2025 •

edited

Loading

Uh oh!

netlify Bot commented Apr 22, 2025 •

edited

Loading

Uh oh!

lindseymoore Apr 22, 2025

Uh oh!

durran Apr 23, 2025

Uh oh!

stephmarie17 left a comment

Uh oh!

stephmarie17 Apr 22, 2025

Uh oh!

lindseymoore Apr 23, 2025

Uh oh!

Uh oh!

stephmarie17 Apr 22, 2025

Uh oh!

lindseymoore Apr 23, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

lindseymoore commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Staging Links

Self-Review Checklist

Uh oh!

netlify Bot commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-node ready!

Uh oh!

lindseymoore Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

durran Apr 23, 2025

Choose a reason for hiding this comment

Uh oh!

stephmarie17 left a comment

Choose a reason for hiding this comment

Uh oh!

stephmarie17 Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

lindseymoore Apr 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stephmarie17 Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

lindseymoore Apr 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lindseymoore commented Apr 22, 2025 •

edited

Loading

netlify Bot commented Apr 22, 2025 •

edited

Loading