Skip to content

Update for DM related docs#22543

Merged
ti-chi-bot[bot] merged 10 commits intopingcap:masterfrom
dveeden:dm_docs_updates
Apr 15, 2026
Merged

Update for DM related docs#22543
ti-chi-bot[bot] merged 10 commits intopingcap:masterfrom
dveeden:dm_docs_updates

Conversation

@dveeden
Copy link
Copy Markdown
Contributor

@dveeden dveeden commented Mar 8, 2026

First-time contributors' checklist

What is changed, added or deleted? (Required)

  • Weaken the stance that we don't support foreign keys
  • Mention binlog transaction compression in a few more places

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)
  • v5.4 (TiDB 5.4 versions)

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

  • This PR is translated from:
  • Other reference 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

@dveeden dveeden requested review from alastori, hfxsd and qiancai March 8, 2026 08:48
@ti-chi-bot ti-chi-bot Bot added the missing-translation-status This PR does not have translation status info. label Mar 8, 2026
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refines the Data Migration (DM) documentation by updating details on foreign key compatibility and integrating explicit requirements for MySQL's binlog_transaction_compression setting. These changes aim to enhance the accuracy and completeness of the documentation, guiding users more effectively through the DM configuration process.

Highlights

  • Foreign Key Documentation Clarification: The documentation's stance on foreign key support in TiDB DM has been softened from 'not supported' to 'not fully supported', providing a more accurate description of compatibility.
  • Binlog Transaction Compression Requirement: Explicit requirements for binlog_transaction_compression=OFF have been added to the DM documentation, including precheck items and configuration examples, to ensure compatibility during data migration.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • dm/dm-compatibility-catalog.md
    • Updated table formatting for data sources.
  • dm/dm-precheck.md
    • Clarified foreign key support from "not supported" to "not fully supported" in precheck descriptions.
    • Added a precheck item for binlog_transaction_compression=OFF.
    • Adjusted table formatting for precheck items.
  • tidb-cloud/migrate-from-mysql-using-data-migration.md
    • Updated table formatting for data sources.
    • Added binlog_transaction_compression = OFF as a required binary log configuration.
    • Included binlog_transaction_compression in the SHOW VARIABLES command example.
    • Added binlog_transaction_compression = OFF to the example MySQL configuration.
Activity
  • No additional activity (comments, reviews, or progress updates) has been recorded on this pull request since its creation.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@ti-chi-bot ti-chi-bot Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 8, 2026
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

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 documentation related to TiDB Data Migration (DM), primarily to clarify foreign key support and add information about binlog transaction compression. The changes correctly reflect that foreign keys are 'not fully supported' rather than 'not supported', and consistently add the binlog_transaction_compression=OFF requirement across relevant documents. The changes are well-aligned with the stated goals. I have one minor suggestion for stylistic consistency.

Note: Security Review has been skipped due to the limited scope of the PR.

Comment thread dm/dm-precheck.md Outdated
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@hfxsd hfxsd added translation/doing This PR's assignee is translating this PR. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. and removed missing-translation-status This PR does not have translation status info. labels Mar 9, 2026
Comment thread tidb-cloud/migrate-from-mysql-using-data-migration.md Outdated
@hfxsd hfxsd self-assigned this Mar 9, 2026
github-actions Bot added a commit to hfxsd/docs-cn that referenced this pull request Mar 9, 2026
Synced from: pingcap/docs#22543
Target PR: pingcap#21420
AI Provider: gemini

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@hfxsd hfxsd added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR's assignee is translating this PR. labels Mar 9, 2026
Copy link
Copy Markdown
Collaborator

@alastori alastori left a comment

Choose a reason for hiding this comment

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

Thanks for the binlog transaction compression additions — those are solid and well-placed across precheck + Cloud migration guide.

Two suggestions on the FK wording and a consistency nit. Context: TiDB fully supports foreign keys (GA since v8.5.0). The limitation is DM's replication behavior, not TiDB's FK support. There's an open issue tiflow#12129 specifically about the misleading DM warning message, and active engineering work on DM FK support this week (tiflow#12552, tiflow#12541, tiflow#12414). The compatibility catalog already correctly frames this as a DM limitation, not a TiDB limitation.

Comment thread dm/dm-precheck.md Outdated
Co-authored-by: Airton Lastori <alastori@gmail.com>
@dveeden
Copy link
Copy Markdown
Contributor Author

dveeden commented Mar 20, 2026

/retest

Comment thread dm/dm-precheck.md Outdated
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Apr 15, 2026
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented Apr 15, 2026

[LGTM Timeline notifier]

Timeline:

  • 2026-04-15 02:27:55.447161345 +0000 UTC m=+1528080.652521412: ☑️ agreed by qiancai.

@hfxsd hfxsd added the lgtm label Apr 15, 2026
@hfxsd
Copy link
Copy Markdown
Collaborator

hfxsd commented Apr 15, 2026

/approve

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented Apr 15, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hfxsd

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

The pull request process is described 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 approved label Apr 15, 2026
@ti-chi-bot ti-chi-bot Bot merged commit 9bf825c into pingcap:master Apr 15, 2026
12 checks passed
ti-chi-bot pushed a commit to ti-chi-bot/docs that referenced this pull request Apr 15, 2026
@ti-chi-bot
Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch release-8.5: #22757.

ti-chi-bot Bot pushed a commit that referenced this pull request Apr 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants