DOCSP-15810: update changestream page to use new feature + cleanup #407
Conversation
This file contains hidden or 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
mongoKart
requested changes
May 24, 2023
Comment on lines
127
to
128
| An update operation on the collection should produce output similar to the | ||
| following text: |
There was a problem hiding this comment.
S: The text you deleted looks fine to me. Otherwise:
Suggested change
| An update operation on the collection should produce output similar to the | |
| following text: | |
| An update operation on the collection produces the following output: |
There was a problem hiding this comment.
changed everywhere
Comment on lines
147
to
149
| - The **pre-image**, which is a document that represents the version of the | ||
| document before the operation, if it exists | ||
| - The **post-image**, which is a document that represents the version of the |
There was a problem hiding this comment.
S: Sounds lighter and cleaner to omit "which is"
Suggested change
| - The **pre-image**, which is a document that represents the version of the | |
| document before the operation, if it exists | |
| - The **post-image**, which is a document that represents the version of the | |
| - The **pre-image**, a document that represents the version of the | |
| document before the operation, if it exists | |
| - The **post-image**, a document that represents the version of the |
Comment on lines
153
to
154
| must connect to a deployment running MongoDB v6.0 or later and perform the | ||
| following actions: |
There was a problem hiding this comment.
S: This sentence is a little hard to parse. Could we move the version info to an admonition or something?
Suggested change
| must connect to a deployment running MongoDB v6.0 or later and perform the | |
| following actions: | |
| must perform perform the following actions on your MongoDB deployment: |
|
|
||
| .. _java-change-stream-pre-post-collection: | ||
|
|
||
| Create a Collection with Pre-Image and Post-Images Enabled | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| To create a collection with the pre-image and post-image option using the | ||
| driver, specify an instance of ``ChangeStreamPreAndPostImagesOptions`` | ||
| To use the driver to create a collection that has the pre-image and post-image options |
There was a problem hiding this comment.
S:
Suggested change
| To use the driver to create a collection that has the pre-image and post-image options | |
| To use the driver to create a collection with the pre-image and post-image options |
Comment on lines
202
to
204
| When you modify this option on a collection, any change streams open on | ||
| that collection in your application may fail if configured to require | ||
| receiving the pre-image or post-image. | ||
| that collection in your application may fail if you configure them to require | ||
| the pre-image or post-image. |
There was a problem hiding this comment.
S: Might be able to trim this down a bit. Style Guide also recommends using "may" only for permission
Maybe something like:
"If you enable this option while change streams are open in your application,
those change streams might fail."
| ``2.1.0``. The corresponding change event output by the preceding code example | ||
| should resemble the following text: | ||
| Suppose you update the ``amount`` field of a document from ``150`` to | ||
| ``2000``. The change event produced by this change should appear in the |
There was a problem hiding this comment.
Suggested change
| ``2000``. The change event produced by this change should appear in the | |
| ``2000``. The change event produced by this change appears in the |
There was a problem hiding this comment.
changed along with changes from an earlier comment
Comment on lines
263
to
265
| ``FullDocument.WHEN_AVAILABLE`` option. This option configures the change | ||
| stream to the change stream to return the post-image of the modified | ||
| document for replace and update change events, if it is available. |
There was a problem hiding this comment.
Suggested change
| ``FullDocument.WHEN_AVAILABLE`` option. This option configures the change | |
| stream to the change stream to return the post-image of the modified | |
| document for replace and update change events, if it is available. | |
| ``FullDocument.WHEN_AVAILABLE`` option. This option configures the change | |
| stream to return the post-image of the modified | |
| document for replace and update change events, if it's available. |
| the value of ``800`` to ``950`` in a collection of city census data. The | ||
| corresponding change event output by the preceding code example should | ||
| resemble the following text: | ||
| Suppose you update the ``color`` field of a document from ``"purple"`` to |
There was a problem hiding this comment.
S: Could say "value of the color field," but this reads fine to me.
rustagir
added a commit
that referenced
this pull request
May 26, 2023
) * DOCSP-15810: update changestream page to use new feature + cleanup * MW PR fixes 1 (cherry picked from commit a175e82)
rustagir
added a commit
that referenced
this pull request
May 26, 2023
) * DOCSP-15810: update changestream page to use new feature + cleanup * MW PR fixes 1 (cherry picked from commit a175e82)
rustagir
added a commit
that referenced
this pull request
May 26, 2023
) * DOCSP-15810: update changestream page to use new feature + cleanup * MW PR fixes 1 (cherry picked from commit a175e82)
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 - DOCSP-30151
Staging
Self-Review Checklist