Skip to content

docs: add CDC production cookbook for full and incremental synchronization (P0-2)#10982

Draft
DanielLeens wants to merge 1 commit into
apache:devfrom
DanielLeens:docs-p0-2-cdc-cookbook
Draft

docs: add CDC production cookbook for full and incremental synchronization (P0-2)#10982
DanielLeens wants to merge 1 commit into
apache:devfrom
DanielLeens:docs-p0-2-cdc-cookbook

Conversation

@DanielLeens
Copy link
Copy Markdown
Contributor

What this PR does

Adds a comprehensive CDC production cookbook for full + incremental synchronization.

New files

  • docs/en/connectors/cdc-production-cookbook.md
  • docs/zh/connectors/cdc-production-cookbook.md

Updated files

  • docs/sidebars.js — added cookbook page under Connectors
  • docs/en/connectors/source/MySQL-CDC.md — added See Also cross-link
  • docs/en/connectors/source/PostgreSQL-CDC.md — added See Also cross-link
  • docs/en/connectors/source/Oracle-CDC.md — added See Also cross-link

Content coverage

  • Full + incremental synchronization lifecycle (phases, startup.mode semantics)
  • Database prerequisites: MySQL binlog setup, PostgreSQL WAL/replication slot, Oracle LogMiner
  • server-id uniqueness requirement for MySQL CDC
  • Production examples: MySQL/PG/Oracle CDC → Doris, StarRocks, Kafka (5 complete configs)
  • Checkpoint and 2PC interaction, commit frequency guidance by scenario
  • Schema evolution and DDL support boundary table
  • CDC lag observation via REST API + monitoring script
  • Troubleshooting checklist: permissions, network, replication/offset, checkpoint, 2PC sink errors

Closes #10979 (P0-2: CDC Production Cookbook)

Add end-to-end CDC production cookbook covering:
- Full + incremental synchronization lifecycle explanation
- startup.mode semantics and production recommendations
- Database prerequisites: MySQL binlog, PostgreSQL WAL/slot, Oracle LogMiner
- Production examples: MySQL/PG/Oracle CDC to Doris, StarRocks, Kafka
- Checkpoint and 2PC interaction with commit frequency guidance
- Schema evolution and DDL support boundary table
- CDC lag observation via REST API and monitoring script
- Troubleshooting checklist: permissions, network, replication, offset, checkpoint, 2PC

Add cross-links from MySQL-CDC.md, PostgreSQL-CDC.md, Oracle-CDC.md.

Closes apache#10979 (P0-2)
@davidzollo davidzollo marked this pull request as draft May 30, 2026 08:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Umbrella][Docs] P0 Documentation Optimization — Tracking

1 participant