DOCSP-45200: Change streams #123
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-ruby ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
jamis
approved these changes
Jan 17, 2025
Comment on lines
20
to
24
| enum = stream.to_enum | ||
| while (doc = enum.next) | ||
| puts doc | ||
| break if doc['operationType'] == 'invalidate' | ||
| end |
There was a problem hiding this comment.
Using stream#each will be simpler, and more idiomatic:
Suggested change
| enum = stream.to_enum | |
| while (doc = enum.next) | |
| puts doc | |
| break if doc['operationType'] == 'invalidate' | |
| end | |
| stream.each do |doc| | |
| puts doc | |
| break if doc['operationType'] == 'invalidate' | |
| end |
Comment on lines
39
to
43
| enum = stream.to_enum | ||
| while (doc = enum.next) | ||
| puts doc | ||
| break if doc['operationType'] == 'invalidate' | ||
| end |
There was a problem hiding this comment.
Explicitly converting the stream to an enum is usually a hint that you're doing something the hard way. Prefer stream#each when iterating over a stream:
Suggested change
| enum = stream.to_enum | |
| while (doc = enum.next) | |
| puts doc | |
| break if doc['operationType'] == 'invalidate' | |
| end | |
| stream.each do |doc| | |
| puts doc | |
| break if doc['operationType'] == 'invalidate' | |
| end |
Comment on lines
50
to
54
| enum = stream.to_enum | ||
| while (doc = enum.next) | ||
| puts doc | ||
| break if doc['operationType'] == 'invalidate' | ||
| end |
There was a problem hiding this comment.
Suggested change
| enum = stream.to_enum | |
| while (doc = enum.next) | |
| puts doc | |
| break if doc['operationType'] == 'invalidate' | |
| end | |
| stream.each do |doc| | |
| puts doc | |
| break if doc['operationType'] == 'invalidate' | |
| end |
jamis
approved these changes
Jan 17, 2025
source/read/change-streams.txt
Outdated
Comment on lines
28
to
31
| When using the {+driver-short+}, you can call the ``watch`` method to return a | ||
| ``Mongo::Collection::View::ChangeStream`` object. Then, you can convert the change | ||
| stream to an ``Enumerator`` object and iterate through its content to monitor data | ||
| changes, such as updates, insertions, and deletions. |
There was a problem hiding this comment.
There's no need to convert the change stream to an enumerator, as the stream is already iterable. Maybe something like the following?
Suggested change
| When using the {+driver-short+}, you can call the ``watch`` method to return a | |
| ``Mongo::Collection::View::ChangeStream`` object. Then, you can convert the change | |
| stream to an ``Enumerator`` object and iterate through its content to monitor data | |
| changes, such as updates, insertions, and deletions. | |
| When using the {+driver-short+}, you can call the ``watch`` method to return a | |
| ``Mongo::Collection::View::ChangeStream`` object. Then, you can iterate through | |
| its content to monitor data changes, such as updates, insertions, and deletions. |
There was a problem hiding this comment.
I like this wording, updated! Sorry about that confusion
source/read/change-streams.txt
Outdated
Comment on lines
64
to
65
| The following example opens a change stream on the ``restaurants`` collection, | ||
| converts the change stream to an ``Enumerator``, and outputs changes as they occur: |
There was a problem hiding this comment.
As mentioned, there's no need to convert the stream to an enumerator.
Suggested change
| The following example opens a change stream on the ``restaurants`` collection, | |
| converts the change stream to an ``Enumerator``, and outputs changes as they occur: | |
| The following example opens a change stream on the ``restaurants`` collection | |
| and outputs changes as they occur: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-45200
Staging Links
Self-Review Checklist