master: clarify DM foreign key support for one-to-one routing#23153
master: clarify DM foreign key support for one-to-one routing#23153OliverS929 wants to merge 3 commits into
Conversation
|
Skipping CI for Draft Pull Request. |
There was a problem hiding this comment.
Code Review
This pull request updates the DM documentation in dm-compatibility-catalog.md and dm-safe-mode.md to detail the behavior, requirements, and limitations of foreign key replication when foreign_key_checks=1 is enabled. The review feedback focuses on aligning the text with the repository style guide by converting passive voice sentences to active voice and ensuring consistent terminology, such as using "routing rules" instead of "route rules" and formatting configuration options with backticks.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
There was a problem hiding this comment.
Pull request overview
This PR updates the DM documentation to more precisely describe foreign key replication behavior when foreign_key_checks=1, especially for multi-worker (worker-count > 1) incremental replication and the routing/configuration constraints that apply in that mode.
Changes:
- Refines the “multi-worker foreign key causality” documentation to explicitly scope it to
foreign_key_checks=1and to document static one-to-one routing support (and its limits). - Expands the compatibility catalog’s foreign key section with additional limitations (routing, unsupported syncer options, hot config update restrictions) and adds a schema correctness note.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
dm/dm-safe-mode.md |
Clarifies the conditions for multi-worker FK causality and documents static one-to-one routing support in that mode. |
dm/dm-compatibility-catalog.md |
Adds/clarifies FK replication limitations and operational restrictions when foreign_key_checks=1, plus a schema correctness note. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Synced from: pingcap/docs#23153 Target PR: pingcap#21747 AI Provider: azure Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
What is changed, added or deleted? (Required)
foreign_key_checks=1.compactandmultiple-rowsare not supported whenforeign_key_checks=1.foreign_key_checks=1andworker-count > 1.Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?