DOCSP-43081: Change Streams - #37
Merged
mcmorisi merged 4 commits intoSep 18, 2024
Merged
Conversation
✅ Deploy Preview for docs-c ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
jordan-smith721
suggested changes
Sep 16, 2024
jordan-smith721
left a comment
jordan-smith721
left a comment
Contributor
There was a problem hiding this comment.
Nice job! Just a few changes
| -------- | ||
|
|
||
| In this guide, you can learn how to use the {+driver-short+} to monitor a **change stream**, | ||
| allowing you to view real-time changes to your database. A change stream is a {+mdb-server+} feature that |
Contributor
There was a problem hiding this comment.
S: Change to data since you can open a change stream on more than just a database
Suggested change
| allowing you to view real-time changes to your database. A change stream is a {+mdb-server+} feature that | |
| allowing you to view real-time changes to your data. A change stream is a {+mdb-server+} feature that |
| -------------------- | ||
|
|
||
| To open a change stream, call one of the following functions that corresponds to the | ||
| scope of events you want to observe. |
Contributor
There was a problem hiding this comment.
Suggested change
| scope of events you want to observe. | |
| scope of events you want to observe: |
Comment on lines
+42
to
+44
| - ``mongoc_client_watch()``: To monitor all changes in the MongoDB deployment | ||
| - ``mongoc_database_watch()``: To monitor changes in all collections in the database | ||
| - ``mongoc_collection_watch()``: To monitor changes in the collection |
Contributor
There was a problem hiding this comment.
Suggested change
| - ``mongoc_client_watch()``: To monitor all changes in the MongoDB deployment | |
| - ``mongoc_database_watch()``: To monitor changes in all collections in the database | |
| - ``mongoc_collection_watch()``: To monitor changes in the collection | |
| - ``mongoc_client_watch()``: Monitors all changes in the MongoDB deployment | |
| - ``mongoc_database_watch()``: Monitors changes in all collections in the database | |
| - ``mongoc_collection_watch()``: Monitors changes in the collection |
Comment on lines
+101
to
+102
| change events. Format the parameter as a list of objects that each represents an | ||
| aggregation stage. |
Contributor
There was a problem hiding this comment.
S:
Suggested change
| change events. Format the parameter as a list of objects that each represents an | |
| aggregation stage. | |
| change events. Format the parameter as a list of objects, where each object represents an | |
| aggregation stage. |
| - ``$set`` | ||
| - ``$unset`` | ||
|
|
||
| Match Specific events Example |
Contributor
There was a problem hiding this comment.
Suggested change
| Match Specific events Example | |
| Match Specific Events Example |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| The following example uses the ``pipeline`` parameter to include a ``$match`` stage | ||
| to open a change stream that only records update operations: |
Contributor
There was a problem hiding this comment.
Suggested change
| to open a change stream that only records update operations: | |
| to open a change stream that records only update operations: |
mcmorisi
marked this pull request as ready for review
September 17, 2024 16:54
jordan-smith721
approved these changes
Sep 17, 2024
jordan-smith721
left a comment
jordan-smith721
left a comment
Contributor
There was a problem hiding this comment.
LGTM w a small fix!
|
|
||
| You can pass the ``pipeline`` parameter to any watch function to modify the | ||
| change stream output. This parameter allows you to watch for only specified | ||
| change events. Format the parameter as a list of object, where each object represents an |
Contributor
There was a problem hiding this comment.
Suggested change
| change events. Format the parameter as a list of object, where each object represents an | |
| change events. Format the parameter as a list of objects, where each object represents an |
kevinAlbs
approved these changes
Sep 18, 2024
kevinAlbs
left a comment
kevinAlbs
left a comment
Collaborator
There was a problem hiding this comment.
LGTM as-is, but added a comment to consider an alternative looping.
| mongoc_change_stream_t *change_stream = | ||
| mongoc_collection_watch (collection, pipeline, opts); | ||
|
|
||
| while (mongoc_change_stream_next (change_stream, &doc)) { |
Collaborator
There was a problem hiding this comment.
mongoc_change_stream_next only returns true when a change is returned within the maxAwaitTimeMS. If no change was returned, and no error occurred, a later call to mongoc_change_stream_next can still return a change.
If the examples are intended to show the behavior of "wait (possibly forever) until there is an event or error", then I suggest looping as follows:
while (true)
{
bson_error_t error;
if (mongoc_change_stream_next(change_stream, &doc))
{
char *str = bson_as_canonical_extended_json(doc, NULL);
printf("Received change: %s\n", str);
bson_free(str);
}
else if (mongoc_change_stream_error_document(change_stream, &error, NULL))
{
printf("Got error on change stream: %s\n", error.message);
break;
}
}
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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-43081
Staging - https://deploy-preview-37--docs-c.netlify.app/read/change-streams
Self-Review Checklist