Repository navigation
RDSC-4929: Clarify SQL Server schema migration and capture history limits - #4239
Merged
Merged
Conversation
Contributor
Contributor
🧠 Redis MemoryFound 6 related items from repository history:
Memory updated at 7f3440e |
EliShteinman
added a commit
to EliShteinman/docs
that referenced
this pull request
Oct 12, 2026
Clarifies SQL Server schema-change handling in RDI and adds an offline schema update procedure. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
SQL Server's existing capture instance can continue emitting the old column structure after a schema change, so an added column can be omitted without an error. The preparation guide currently describes this as always producing errors, and the FAQ implies automatic column handling also applies to SQL Server.
This change explains the SQL Server exception, links the FAQ to the migration procedure, and gives RDI-specific offline migration steps when the online transition gap is unacceptable. The procedure pauses application writes, checks that final changes reached the target, stops and starts only the SQL Server source with the RDI CLI, and verifies the updated columns before deleting old capture history. It also adds the missing consequence of deleting the old capture instance: changes available only in its change table cannot be recovered by rewinding an offset. Retention cleanup and the two capture instance limit still apply while the old instance is retained. The final check verifies column values rather than only continued streaming or row counts.
Validation:
git diff --checkpasses.Sources: Debezium SQL Server schema evolution, Microsoft capture-instance deletion, and Microsoft CDC retention and instance limits.
Related offset research: RDI PR #2885.
Note
Low Risk
Documentation-only updates to SQL Server CDC schema migration guidance; no runtime or product code changes.
Overview
Corrects SQL Server CDC schema-change behavior in the RDI prep guide and FAQ: schema updates no longer described as always causing errors; the docs now state that the existing capture instance keeps the old column layout, so new columns can be omitted silently until a new capture instance is created.
The online migration steps are tightened (transition-window caveats, when to use offline migration, post-migration column-value verification). Dropping the old capture instance now documents non-recoverable history, CDC retention, and the two capture-instance-per-table limit.
Adds a new “Update the schema offline” section with RDI-specific steps (
redis-di describe/stop/start, suspend writes, deploy config if columns/transformations changed). The FAQ now calls out SQL Server as an exception to automatic column tracking and links to the migration guide.Reviewed by Cursor Bugbot for commit 7f3440e. Bugbot is set up for automated code reviews on this repo. Configure here.