DOCSP-45199: Cursors #120

norareidy · 2025-01-07T22:47:33Z

Pull Request Info

PR Reviewing Guidelines

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

Staging Links

read/cursors

read

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?

netlify · 2025-01-07T22:47:50Z

✅ Deploy Preview for docs-ruby ready!

Name	Link
🔨 Latest commit	`2ec006c`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-ruby/deploys/677fe856663b8b00080ba374
😎 Deploy Preview	https://deploy-preview-120--docs-ruby.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.

jordan-smith721

LGTM w/ a couple suggestions

jordan-smith721 · 2025-01-08T15:59:54Z

source/read/cursors.txt

+To retrieve all documents from a cursor, convert the cursor into an array by using
+the ``to_a`` method on its corresponding ``Mongo::Collection::View`` object.
+
+The following example calls the ``to_a`` to store the cursor results


Suggested change

The following example calls the ``to_a`` to store the cursor results

The following example calls the ``to_a`` method to store the cursor results

jordan-smith721 · 2025-01-08T16:02:46Z

source/read/cursors.txt

+For example, you can create a capped collection called ``vegetables`` that stores
+documents representing vegetables, as shown in the following code:


S: I think this part is implied so can be removed

Suggested change

For example, you can create a capped collection called ``vegetables`` that stores

documents representing vegetables, as shown in the following code:

For example, you can create a capped collection called ``vegetables``

as shown in the following code:

jordan-smith721 · 2025-01-08T16:06:58Z

source/read/cursors.txt

+The following code uses a tailable cursor to retrieve all documents in the ``vegetables``
+collection. After the cursor is exhausted, it remains open until retrieving three documents:


I didn't realize at first that this was a continuation of the example and steps above it. Maybe rewording can help that:

Suggested change

The following code uses a tailable cursor to retrieve all documents in the ``vegetables``

collection. After the cursor is exhausted, it remains open until retrieving three documents:

Then, you can use the following code to create a tailable cursor that retrieves all documents in the ``vegetables``

collection. After the cursor is exhausted, it remains open until retrieving three documents.

comandeo-mongo

LGTM, just some minor style changes

comandeo-mongo · 2025-01-09T08:14:41Z

source/includes/read/cursors.rb

+
+  # Converts the documents stored in a cursor to an array
+  # start-cursor-array
+  cursor = collection.find({ name: "Dunkin' Donuts" })


Suggested change

cursor = collection.find({ name: "Dunkin' Donuts" })

cursor = collection.find(name: "Dunkin' Donuts")

comandeo-mongo · 2025-01-09T08:15:23Z

source/includes/read/cursors.rb

+
+  # Iterates over and prints all documents that have a "name" value of "Dunkin' Donuts"
+  # start-cursor-iterate
+  cursor = collection.find({ name: "Dunkin' Donuts" })


Suggested change

cursor = collection.find({ name: "Dunkin' Donuts" })

cursor = collection.find(name: "Dunkin' Donuts")

If hash is the only argument of a method, curly braces are usually omitted. We follow this style on other pages in the documentation, maybe we should be consistent.

comandeo-mongo · 2025-01-09T08:15:37Z

source/includes/read/cursors.rb

+
+  # Retrieves and prints the first document stored in the cursor
+  # start-cursor-first
+  cursor = collection.find({ name: "Dunkin' Donuts" })


Suggested change

cursor = collection.find({ name: "Dunkin' Donuts" })

cursor = collection.find(name: "Dunkin' Donuts")

* add actions * Update add-netlify-links.yml (#90) (#91) (cherry picked from commit c2b53c0) Co-authored-by: Mike Woofter <108414937+mongoKart@users.noreply.github.com> * DOCSP-45177 - Create a client (#88) * DOCSP-45170: Landing page and cleanup (#89) * DOCSP-45170: Landing page and cleanup * copy snooty file * fix toc * netlify script * fix * put old files in folder * MW feedback * DOCSP-45171: Download and Install (#92) * DOCSP-45171: Download and Install * snooty * landing page * MW feedback * DR feedback * fix * DOCSP-45173: Deployment & connection string (#94) * DOCSP-45173: Deployment & connection string * edits * edit image * SA feedback * DOCSP-45187: Update * Fixes * Fix * DOCSP-45175: Connect to MongoDB (#95) * DOCSP-45175: Connect to MongoDB * fixes * edits, next steps * JS feedback * DR feedback * Fix * MW feedback * DOCSP-45194: Retrieve data (#96) * DOCSP-45194: Retrieve data * edits * build errors * api links * JB feedback * DOCSP-45186: Insert * Fix * Fix * Fix * DOCSP-45212 Compatibility (#97) * NR feedback * MW feedback + adjusting code to be more idiomatic * DOCSP-45189: Delete * Fixes * Fix * DOCSP-45188: Replace * JS feedback * DOCSP-45203 Single Field Indexes (#100) * add files * Update add-netlify-links.yml (#90) * DOCSP-45076: Document that count supports different filters from countDocuments * Test fix * Fix * Try again * Never mind * NR suggestion * DOCSP-45203 Single Field Indexes * Edits * edits * get rid of old commit work * code spacing * Stephanie's reiview * Tech review code improvements * update api links * add a space at eof * update listing description * add context to ex query code comment * style edit on prev --------- Co-authored-by: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Co-authored-by: Michael Morisi <michael.morisi@mongodb.com> * Technical feedback * DOCSP-45188: Replace * Fixes * JS feedback * DOCSP-45210 What's New (#99) * DOCSP-45195: Project fields (#105) * DOCSP-45195: Project fields * edits * SA feedback * DOCSP-45196: Limit, skip, and sort (#109) * DOCSP-45196: Limit, skip, and sort * code output * fixes * DOCSP-45193: Specify queries (#102) * DOCSP-45193: Specify queries * edits * wording * LM feedback * JB feedback * DOCSP-45197: Count documents (#110) * DOCSP-45197: Count documents * edits * code fix * JS feedback * DOCSP-45198: Distinct values (#111) * DOCSP-45198: Distinct values * edits * RR feedback * DOCSP-45185: Write landing page * Fixes * MW feedback * DOCSP-45204 Compound Index (#106) * DOCSP-45204 Compound Index * fix ref * fix code comment spacing * specify create one ref * bold single field * tech review comment * remove comments from snippet and spacing fix * repeated text * DOCSP-45205 Multikey Indexes (#103) * DOCSP-45205 Multikey Indexes * first draft * edits * remove quotes from key name * remove comments from code snippets * DOCSP-45190: Bulk Write * Fixes * link fix * Fix * JS feedback * DOCSP-45182-ruby-databases-collection-2 * added api links * links * better link * style guide and link fixes * api fixes * testing bundler * DOCSP-45191: GridFS * Fix * added separate text file, deleted some pages that were added on from a new pr * DOCSP-45214 Add transactions (#115) * feedback * more feedback * link * final link * DOCSP-45191: MW feedback * small change * small change * revert change * DOCSP-45184-ruby-replica-sets * fix errors and links * fixes * link fix * syntax * last fixes * DOCSP-45183-time-series-collections * DOCSP-45181: Stable API * Fix * half feedback * LM feedback * DOCSP-45199: Cursors (#120) * DOCSP-45199: Cursors * edits * fix link * JS feedback * tech review * other half of feedback * style guide * added more copy * added page * formatting * trying for output * again * formatting * DOCSP-45191: GridFS follow-up * Fix * Jamis technical feedback * add * feedback * ahh * toctree * api links * feedback * toctree and errors * file * errors * DOCSP-45209: Authentication landing + Authentication mechanisms * Fixes * feedback * fix build * update toctree * Reorganize auth mechanisms to separate pages * Fix * redoing feedback that got merged out * toctree * Fix * fix typo * mark troubleshooting todo * feedback * DOCSP-45192-read-data-page * Tweak the Kerberos and IAM pages * Fix * wrote page * fix links * last link fix * feedback * keyword * keyword 2 * feedback * fix link * MW feedback, round 1 * Fix * Fix * Kerberos file tweaks, also fixes * Fix * DOCSP-45176: Run a command * Fix * RM feedback * DOCSP-45202 Index Overview (#112) * DOCSP-45202 Index Overview * edits * fix ref * atlas search updates * small fix * add api section, edit atlas search examples * edits * tech review * DOCSP-45206 Atlas Search Index (#113) * DOCSP-45206 Atlas Search Indexes * first draft * draft code * edits * using native api * edits * emphasize lines * RM typo * var rename * code spacing * DOCSP-45178 Choose a Connection Target (#125) * DOCSP-45178 Choose a Connection Target * edits and add page to TOC * more small edits * last edits * no hyper linked period * coe improvements * stable api single quote * feedback * feedback * fix toctree issue * DOCSP-45192-read-data-page * quotes * label * link * Second round of MW feedback * Fixes * Fix * MW feedback * feedback * fix typo * DOCSP-45200: Change streams (#123) * DOCSP-45200: Change streams * edits * JB feedback * Jamis feedback * DOCSP-45179 Configure TLS (#129) * Configure TLS * insecure tls * edits * monospace * 1/2 MW edits * last of MW revisions and table * table reformat * spacing edit * formatting edits * format * edit * MW last comments * small change * tech review * DOCSP-45207 Transform data with aggregation (#131) * DOCSP-45812 Connection Options (#132) * DOCSP-45812 Connection Options * edits * more edits * more edits * format * format * RM review * another link * add timeout_ms * remove deprecated options * DOCSP-45211 Upgrade major versions (#134) * DOCSP-46860: In-use encryption (#138) * DOCSP-45201 Cluster monitoring (#133) * DOCSP-45201 Cluster monitoring * first draft * remove eevrything not about cluster monitoring: * table changes * review * final few changes * NR review comments * NR comments * look through * tech review comments * DOCSP-45180 Server selection (#135) * DOCSP-45188 Server selection * quick add * remove page * spacing * review comment * same edit * tech review * DOCSP-46862 Issues & Help (#139) * DOCSP-46862 Issues & Help * edits * internal review * weird build fail * build mysteriously good again * DOCSP-42104 CSOT (#136) * first draft * revisions * edit * edits * code edits * Rea comments * edits * last internal comments * tech review + add atlas search api refs * edit to api refs * code comment edit * fix code example option name * DOCSP-46650: Cleanup (#137) * DOCSP-46650: Cleanup * redirects * more cleanup * rename, test api link * api links * fix toc api link * monitoring, edits * check api links * LM feedback * snooty * remove old redirects * LM feedback --------- Co-authored-by: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Michael Morisi <michael.morisi@mongodb.com> Co-authored-by: Stephanie <52582720+stephmarie17@users.noreply.github.com> Co-authored-by: lindseymoore <71525840+lindseymoore@users.noreply.github.com> Co-authored-by: Grace Miller <grace.miller@mongodb.com> Co-authored-by: rustagir <rea.rustagi@mongodb.com> Co-authored-by: gmiller-mdb <135852653+gmiller-mdb@users.noreply.github.com>

DOCSP-45199: Cursors

39f4e9a

norareidy added 2 commits January 8, 2025 10:30

edits

9e849f6

fix link

7eefafe

jordan-smith721 approved these changes Jan 8, 2025

View reviewed changes

JS feedback

fbdcc85

norareidy requested a review from comandeo-mongo January 8, 2025 19:49

comandeo-mongo requested changes Jan 9, 2025

View reviewed changes

tech review

2ec006c

norareidy requested a review from comandeo-mongo January 9, 2025 15:16

comandeo-mongo approved these changes Jan 9, 2025

View reviewed changes

norareidy merged commit 9f42b50 into mongodb:standardization Jan 9, 2025
5 checks passed

norareidy deleted the DOCSP-45199-cursor branch January 9, 2025 16:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCSP-45199: Cursors #120

DOCSP-45199: Cursors #120

norareidy commented Jan 7, 2025 •

edited

Loading

netlify bot commented Jan 7, 2025 •

edited

Loading

jordan-smith721 left a comment

jordan-smith721 Jan 8, 2025

jordan-smith721 Jan 8, 2025

jordan-smith721 Jan 8, 2025

comandeo-mongo left a comment

comandeo-mongo Jan 9, 2025

comandeo-mongo Jan 9, 2025

comandeo-mongo Jan 9, 2025

	The following example calls the ``to_a`` to store the cursor results
	The following example calls the ``to_a`` method to store the cursor results

		For example, you can create a capped collection called ``vegetables`` that stores
		documents representing vegetables, as shown in the following code:

		The following code uses a tailable cursor to retrieve all documents in the ``vegetables``
		collection. After the cursor is exhausted, it remains open until retrieving three documents:

	cursor = collection.find({ name: "Dunkin' Donuts" })
	cursor = collection.find(name: "Dunkin' Donuts")

DOCSP-45199: Cursors #120

DOCSP-45199: Cursors #120

Conversation

norareidy commented Jan 7, 2025 • edited Loading

Pull Request Info

Staging Links

Self-Review Checklist

netlify bot commented Jan 7, 2025 • edited Loading

✅ Deploy Preview for docs-ruby ready!

jordan-smith721 left a comment

Choose a reason for hiding this comment

jordan-smith721 Jan 8, 2025

Choose a reason for hiding this comment

jordan-smith721 Jan 8, 2025

Choose a reason for hiding this comment

jordan-smith721 Jan 8, 2025

Choose a reason for hiding this comment

comandeo-mongo left a comment

Choose a reason for hiding this comment

comandeo-mongo Jan 9, 2025

Choose a reason for hiding this comment

comandeo-mongo Jan 9, 2025

Choose a reason for hiding this comment

comandeo-mongo Jan 9, 2025

Choose a reason for hiding this comment

norareidy commented Jan 7, 2025 •

edited

Loading

netlify bot commented Jan 7, 2025 •

edited

Loading