Add documentation on CDC Engine for subscriptions #56
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
angrykoala
force-pushed
the
cdc-engine
branch
from
35abce6 to
4c70a89
Compare
|
Thanks for the documentation updates. The preview documentation has now been torn down - reopening this PR will republish it. |
mjfwebb
reviewed
Oct 31, 2023
Comment on lines
+64
to
+66
| * **driver**: The driver to be used for CDC queries. | ||
| * **pollTime**: The interval, in milliseconds, between queries to CDC. Defaults to 100ms. Note that poll time is the period between one request finishing and the next one starting. The actual time it takes for CDC events to trigger the subscription will also depend on your network. | ||
| * **queryConfig**: An object with the driver query options to be passed to CDC requests. Use the **db** field to define the target db for CDC. |
There was a problem hiding this comment.
I always wonder about this when reading documents which describe optional constructor parameters, but do you think it would be useful to also provide a code example of these being used?
There was a problem hiding this comment.
Maybe that could be a good idea 🤔
MacondoExpress
approved these changes
Oct 31, 2023
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.
Adds documentation on support for CDC on subscriptions, added on the version 4.4.0 of the library