Skip to content

docs: Document SQL CDC features introduced in DM-SQL-to-FalkorDB#495

Merged
shahar-biron merged 10 commits into
mainfrom
feat/docs-sql-cdc-updates-clean
Jun 28, 2026
Merged

docs: Document SQL CDC features introduced in DM-SQL-to-FalkorDB#495
shahar-biron merged 10 commits into
mainfrom
feat/docs-sql-cdc-updates-clean

Conversation

@shahar-biron

@shahar-biron shahar-biron commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

Description

This updates the sql-to-falkordb.md migration guide to document the native Change Data Capture (CDC) capabilities introduced in the v1.1.x release line of DM-SQL-to-FalkorDB.

Specifically, it highlights:

  • PostgreSQL: Native logical replication CDC via pgoutput.
  • MySQL & MariaDB: Native CDC via Binlog streaming.
  • Snowflake: Native zero-loss CDC leveraging Snowflake Streams within transactional boundaries.

Created with the assistance of Warp Oz

Summary by CodeRabbit

  • Documentation
    • Added Oracle to the supported SQL sources and expanded migration guidance with Oracle-specific setup, sync, and CDC examples.
    • Updated notes on purge modes, schema scaffolding, and metrics ports to include Oracle.
  • Chores
    • Refined the word list by normalizing capitalization, removing duplicates, and adding a few missing terms.

@coderabbitai

coderabbitai Bot commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@shahar-biron, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 26 minutes and 52 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a45adc71-df8d-4d3b-90df-d8105b64f1aa

📥 Commits

Reviewing files that changed from the base of the PR and between 51f6d6e and ef02a83.

📒 Files selected for processing (2)
  • .wordlist.txt
  • operations/migration/sql-to-falkordb.md
📝 Walkthrough

Walkthrough

Oracle is added as a supported source throughout the SQL-to-FalkorDB migration documentation, covering CDC (LogMiner), CLI usage, purge modes, schema introspection, metrics port (9998), and FAQ. The .wordlist.txt spell-check file is normalized by removing lowercase duplicates, adding new terms (DML, LSN, tooltip, uptime, vl), and deleting trailing duplicates.

Changes

Oracle Migration Documentation

Layer / File(s) Summary
Oracle support across migration guide
operations/migration/sql-to-falkordb.md
Adds Oracle to the supported-sources list, populates the CDC section with LogMiner details, introduces an Oracle CLI usage subsection (one-shot, continuous, CDC modes), and updates purge modes, schema introspection, metrics port, and FAQ to include Oracle.

Wordlist Normalization

Layer / File(s) Summary
Case normalization and new terms
.wordlist.txt
Removes lowercase duplicates throughout the file, adds new terms (DML, LSN, tooltip, uptime, vl), and removes trailing duplicate entries.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

A rabbit hops through docs so bright,
Oracle joins the migration night,
Wordlists tidied, cases right,
LogMiner logs by candlelight—
Every source now spelled just right! 🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: documenting newly introduced SQL CDC features in DM-SQL-to-FalkorDB.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/docs-sql-cdc-updates-clean

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the SQL-to-FalkorDB online migration guide to document newly supported native Change Data Capture (CDC) capabilities in DM-SQL-to-FalkorDB, and expands the docs spellcheck allowlist.

Changes:

  • Added a “Change Data Capture (CDC)” section describing native CDC support for PostgreSQL, MySQL/MariaDB, and Snowflake.
  • Significantly expanded/updated .wordlist.txt to include additional allowed terms for docs spellchecking.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
operations/migration/sql-to-falkordb.md Adds a new CDC documentation section to the SQL migration guide.
.wordlist.txt Updates the spellcheck allowlist with many additional terms/acronyms.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


### Change Data Capture (CDC)

Certain loaders natively support real-time Change Data Capture beyond traditional timestamp polling:

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
operations/migration/sql-to-falkordb.md (1)

71-79: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Clarify Oracle CDC latency expectations.

The Oracle entry claims "real-time CDC" but describes "polling Oracle LogMiner." Polling implies periodic latency versus the true streaming mechanisms described for MySQL (Binlog streaming) and PostgreSQL (logical replication). Consider qualifying this as "near real-time" or specifying the polling interval to set accurate expectations.

- - **Oracle**: Supports real-time CDC by polling Oracle LogMiner for System Change Number (SCN) updates.
+ - **Oracle**: Supports CDC by polling Oracle LogMiner for System Change Number (SCN) updates.

Or, if you want to keep the real-time framing:

- - **Oracle**: Supports real-time CDC by polling Oracle LogMiner for System Change Number (SCN) updates.
+ - **Oracle**: Supports near real-time CDC by polling Oracle LogMiner for System Change Number (SCN) updates.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@operations/migration/sql-to-falkordb.md` around lines 71 - 79, The Oracle CDC
description in the CDC section overstates “real-time” while the implementation
described is polling LogMiner; update the Oracle entry to use more accurate
wording such as “near real-time” or explicitly mention the polling cadence. Use
the Oracle bullet in the Change Data Capture section to align the latency
expectations with the actual LogMiner polling behavior, keeping the phrasing
consistent with the other loader entries.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@operations/migration/sql-to-falkordb.md`:
- Around line 71-79: The Oracle CDC description in the CDC section overstates
“real-time” while the implementation described is polling LogMiner; update the
Oracle entry to use more accurate wording such as “near real-time” or explicitly
mention the polling cadence. Use the Oracle bullet in the Change Data Capture
section to align the latency expectations with the actual LogMiner polling
behavior, keeping the phrasing consistent with the other loader entries.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a443e63d-baef-4068-af69-a85e73ea01e2

📥 Commits

Reviewing files that changed from the base of the PR and between 53c2f20 and 51f6d6e.

📒 Files selected for processing (2)
  • .wordlist.txt
  • operations/migration/sql-to-falkordb.md

@shahar-biron shahar-biron merged commit 6805ce6 into main Jun 28, 2026
6 checks passed
@shahar-biron shahar-biron deleted the feat/docs-sql-cdc-updates-clean branch June 28, 2026 06:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants