Skip to content

Clarify DM foreign key support for one-to-one routing#23153

Open
OliverS929 wants to merge 2 commits into
pingcap:masterfrom
OliverS929:dm-fk-doc-update
Open

Clarify DM foreign key support for one-to-one routing#23153
OliverS929 wants to merge 2 commits into
pingcap:masterfrom
OliverS929:dm-fk-doc-update

Conversation

@OliverS929

Copy link
Copy Markdown

What is changed, added or deleted? (Required)

  • Clarify DM foreign key replication constraints when foreign_key_checks=1.
  • Document that DM supports static one-to-one table routing for multi-worker foreign key causality, and still rejects route rules that map multiple source tables in the task to the same target table in this mode.
  • Document that compact and multiple-rows are not supported when foreign_key_checks=1.
  • Document hot configuration update restrictions when foreign_key_checks=1 and worker-count > 1.
  • Add a schema correctness note recommending standard foreign key definitions before migration.

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.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot ti-chi-bot Bot added first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Jun 26, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jun 26, 2026

Copy link
Copy Markdown

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@ti-chi-bot

ti-chi-bot Bot commented Jun 26, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign icemap for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot Bot added the missing-translation-status This PR does not have translation status info. label Jun 26, 2026
@pingcap-cla-assistant

pingcap-cla-assistant Bot commented Jun 26, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@ti-chi-bot ti-chi-bot Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jun 26, 2026

@gemini-code-assist gemini-code-assist 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.

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.

Comment thread dm/dm-compatibility-catalog.md Outdated
Comment thread dm/dm-compatibility-catalog.md Outdated
Comment thread dm/dm-compatibility-catalog.md Outdated
Comment thread dm/dm-compatibility-catalog.md Outdated
Comment thread dm/dm-compatibility-catalog.md Outdated
Comment thread dm/dm-compatibility-catalog.md Outdated
Comment thread dm/dm-compatibility-catalog.md Outdated
Comment thread dm/dm-safe-mode.md Outdated
Comment thread dm/dm-safe-mode.md Outdated
@OliverS929 OliverS929 marked this pull request as ready for review June 26, 2026 04:23
@ti-chi-bot ti-chi-bot Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 26, 2026
@OliverS929 OliverS929 mentioned this pull request Jun 26, 2026
13 tasks
@lilin90 lilin90 self-assigned this Jun 26, 2026
@lilin90 lilin90 added the translation/doing This PR's assignee is translating this PR. label Jun 26, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Jun 26, 2026
@lilin90 lilin90 added the needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. label Jun 26, 2026
github-actions Bot pushed a commit to doc-claw-bot/pingcap-docsite-preview that referenced this pull request Jun 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. translation/doing This PR's assignee is translating this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants