docs(features): add Database Replication and CDC, and the Analytics Replica use case - #136
Merged
lukekim merged 3 commits intoAug 2, 2026
Conversation
added 2 commits
August 2, 2026 10:25
lukekim
approved these changes
Aug 2, 2026
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
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
Database replication had no feature page, despite CDC being the capability behind
refresh_mode: changes. It was only findable as a FAQ answer and a handful of scattered mentions. This adds the missing feature page and the use-case page for the architecture built on it.New:
features/database-replication-and-cdc.md— what database replication and change data capture are, why it beats ETL / read replicas / HTAP for analytical load, the supported sources and their mechanisms, configuration, PostgreSQL source prerequisites, and how hard deletes differ from incremental ingestion.New:
use-cases/analytics-replica.md— the analytics replica pattern: attach a columnar node to an operational database, load a snapshot, then apply committed changes continuously so analytics runs seconds behind without touching the primary. Covers why it differs from a read replica (storage layout and execution engine, not just load placement), table-by-table adoption, and governing access at the replica.Both are wired into the root
SUMMARY.md, and the Welcome page's use-case table gains an Analytics Replica row.features/data-acceleration/README.mdgains one line pointingrefresh_mode: changesat the new page.Pages updated
features/database-replication-and-cdc.md— newuse-cases/analytics-replica.md— newSUMMARY.md— Database Replication and CDC under Features, Analytics Replica under Use-CasesREADME.md— one row in the use-case tablefeatures/data-acceleration/README.md— cross-link from the refresh-modes tableVerification
refresh_mode: changesis documented in the public OSS docs, and native PostgreSQL WAL, MongoDB Change Streams, and DynamoDB Streams CDC all appear in shipped releases inchangelog/README.md.wal_level = logical,REPLICA IDENTITY FULL, theREPLICATIONrole attribute) and the acceleration block taken from the published OSS reference.SUMMARY.md, so neither ships unreachable.README.mdare untouched by this branch — see below.{% hint %}syntax, not:::.building-blocks/untouched.Coordination with #127
#127 (open, sitewide link repair) touches
README.mdandfaq.md. This branch was scoped to stay out of its way:README.mdchange here is a single new row in the use-case table, in a region fix(docs): repair broken and cross-space docs links sitewide #127 does not touch. The five pre-existing broken links in that file are all ones fix(docs): repair broken and cross-space docs links sitewide #127 fixes, so they were deliberately left alone.faq.mdwas not edited even though its CDC answer is the natural place to link this from, because fix(docs): repair broken and cross-space docs links sitewide #127 rewrites those exact lines. Worth a follow-up once it merges: the answer omits MongoDB Change Streams, which is a native CDC source.Not a blocker for this PR, but worth a look before #127 merges: it appears to repoint the Apache Kafka bullet in
faq.mdatdata-connectors/debezium.mdinstead ofdata-connectors/kafka.md.Update — page renamed
Renamed to Database Replication and CDC (from "Replication") at review request. The file was renamed to
features/database-replication-and-cdc.mdto match, along with theSUMMARY.mdentry and both inbound cross-links.Renaming the file was free here because the page has never been published — doing it after merge would have needed a GitBook redirect. The body now introduces "change data capture (CDC)" explicitly as the mechanism, rather than only describing change feeds.
origin/trunkwas merged into the branch (no force-push) to pick up the apps→projects portal sweep that landed while this was open.