Add setup instruction for DocumentDB support #4715
Draft
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
|
|
jgao54
force-pushed
the
docdb
branch
2 times, most recently
from
a5812c3 to
fc7f112
Compare
jgao54
force-pushed
the
docdb
branch
2 times, most recently
from
10824fc to
d415deb
Compare
jgao54
force-pushed
the
docdb
branch
2 times, most recently
from
013cbfb to
9e21314
Compare
ilidemi
approved these changes
Nov 7, 2025
| --- | ||
| sidebar_label: 'Amazon DocumentDB' | ||
| description: 'Step-by-step guide on how to set up Amazon DocumentDB as a source for ClickPipes' | ||
| slug: /integrations/clickpipes/mongodb/source/docdb |
Member
There was a problem hiding this comment.
Suggested change
| slug: /integrations/clickpipes/mongodb/source/docdb | |
| slug: /integrations/clickpipes/mongodb/source/documentdb |
(+ filename and sidebars)
|
|
||
| ## Configure change stream log retention {#configure-change-stream-log-retention} | ||
|
|
||
| By default, Amazon DocumentDB has a 3-hour change stream log retention period, initial load may take much longer depending on existing data volume in your DocumentDB. We recommend setting the change stream log retention to 72 hours or longer to ensure that it is not truncated before the initial snapshot is completed. |
Member
There was a problem hiding this comment.
Suggested change
| By default, Amazon DocumentDB has a 3-hour change stream log retention period, initial load may take much longer depending on existing data volume in your DocumentDB. We recommend setting the change stream log retention to 72 hours or longer to ensure that it is not truncated before the initial snapshot is completed. | |
| By default, Amazon DocumentDB has a 3-hour change stream log retention period, while initial load may take much longer depending on existing data volume in your DocumentDB. We recommend setting the change stream log retention to 72 hours or longer to ensure that it is not truncated before the initial snapshot is completed. |
|
|
||
| ### Update change stream log retention via AWS CLI {#update-change-stream-log-retention-via-aws-cli} | ||
|
|
||
| To check the current change stream log retention period via AWS CLI: |
Member
There was a problem hiding this comment.
After scrolling through the helpful screenshots one may lose track of the headings and think it's the next step
Suggested change
| To check the current change stream log retention period via AWS CLI: | |
| Alternatively, you can configure this via AWS CLI. To check the current change stream log retention period: |
(if looks good, trim "via AWS CLI" in the next one too)
| For more information refer to the source MongoDB setup guides linked at [the top of this page](#prerequisites). | ||
| ::: | ||
|
|
||
| <Image img={mongodb_connection_details} alt="Fill in connection details" size="lg" border/> |
Member
There was a problem hiding this comment.
Should this screenshot be updated for continuity (don't see the SSH toggle there)?
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.
Summary
Add setup instruction on Amazon DocumentDB support, including SSH tunneling and PrivateLink info.
Keeping this as draft until post-release.