DOCSP-45194: Retrieve data

[norareidy]

Pull Request Info

PR Reviewing Guidelines

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

Staging Links

read

read/retrieve

get-started/create-a-connection-string

get-started/create-a-deployment

index

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]

✅ Deploy Preview for docs-ruby ready!

Name	Link
🔨 Latest commit	c05e895
🔍 Latest deploy log	https://app.netlify.com/sites/docs-ruby/deploys/675b57d6ca565b0008507a83
😎 Deploy Preview	https://deploy-preview-96--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.

[mcmorisi]

LGTM with some questions!

[mcmorisi]

Echoes a similar question elsewhere in the review – should I not refer to methods by name using parentheses (i.e. find())?

[norareidy]

asked in the group slack channel!

[jamis]

Parentheses are optional in Ruby as long as it isn't ambiguous. By convention, we typically omit parens for zero-argument calls (e.g. client.close), single-argument calls (often when the argument is a literal value, e.g. puts "hello"), and when the only argument is a Hash instance (in which case the curly braces are also optional, e.g. Foo.new a: 1, b: 'hi', c: var).

[norareidy]

Makes sense, thank you!

[jamis]

Just a few suggestions to make the Ruby code a bit more idiomatic. 👍

[jamis]

This isn't wrong, but it might be more idiomatically written as:

Suggested change

	document = collection.find({ 'name' => 'LinkedIn' }).first
	document = collection.find(name: 'LinkedIn').first

[jamis]

As before, more idiomatically written as:

Suggested change

	results = collection.find({ 'founded_year' => 1970 })
	results = collection.find(founded_year: 1970)

[jamis]

Suggested change

	limit_results = collection.find({ 'number_of_employees' => 1000 }).limit(2)
	limit_results = collection.find(number_of_employees: 1000).limit(2)

[jamis]

Wrapping this all in a begin/ensure/end block isn't wrong, but the initializer for Mongo::Client will do it all for you if you pass a block to it, e.g.:

Mongo::Client.new(uri) do |client|
  # processing here, with the `client` reference.
  # the client will be closed automatically when the block terminates.
end

This idiom is preferred for a lot of things in Ruby, where resources need to be cleaned up after being used, like with File.open and network operations.

[jamis]

Suggested change

	:description: Learn how to use the Ruby driver to read data to MongoDB.
	:description: Learn how to use the Ruby driver to read data from MongoDB.

[jamis]

Parentheses are optional in Ruby as long as it isn't ambiguous. By convention, we typically omit parens for zero-argument calls (e.g. client.close), single-argument calls (often when the argument is a literal value, e.g. puts "hello"), and when the only argument is a Hash instance (in which case the curly braces are also optional, e.g. Foo.new a: 1, b: 'hi', c: var).