Add essential migration doc #21849

xuanyu66 · 2025-09-30T02:41:32Z

First-time contributors' checklist

I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

What is changed, added or deleted? (Required)

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)?

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

ti-chi-bot · 2025-09-30T02:41:39Z

[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 overvenus 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.

Needs approval from an approver in each of these files:

OWNERS

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

gemini-code-assist · 2025-09-30T02:41:47Z

Summary of Changes

Hello @xuanyu66, I'm Gemini Code Assist¹! 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 introduces two new essential documentation pages for TiDB Cloud, guiding users through the process of migrating MySQL-compatible databases to TiDB Cloud Essential. The documentation covers detailed steps for both full data migration (existing and incremental) and incremental-only migration, including critical prerequisites like binary log configuration, network setup, and privilege management, aiming to simplify and streamline the migration experience for various cloud and self-managed MySQL environments.

Highlights

New Migration Guide (Full & Incremental): A new document migrate-from-mysql-using-data-migration-essential.md has been added, providing a comprehensive guide for migrating MySQL-compatible databases (including Amazon Aurora MySQL, Amazon RDS, Azure Database for MySQL, Google Cloud SQL for MySQL, and self-managed MySQL) to TiDB Cloud Essential. This guide covers both existing data and continuous incremental replication.
New Migration Guide (Incremental Only): A companion document migrate-incremental-data-from-mysql-using-data-migration-essential.md has been added, specifically detailing the process for migrating only incremental data from MySQL-compatible sources to TiDB Cloud Essential.
Detailed Prerequisites: Both guides include extensive prerequisites, such as supported data sources and versions, binary log configuration for replication (log_bin, binlog_format, binlog_row_image, binlog_expire_logs_seconds), network connectivity setup (public endpoints, private links, TLS/SSL), and necessary user privileges for both source and target databases.
Step-by-Step Migration Process: The documents outline a clear 7-step process for setting up and executing a data migration job, from navigating the TiDB Cloud console to configuring connections, choosing migration types, selecting objects, prechecks, spec selection, and monitoring progress.
Specific Limitations and Troubleshooting: Each guide details specific limitations related to availability, maximum job count, filtered databases, and nuances of existing vs. incremental data migration, along with references to troubleshooting resources for precheck and migration errors.

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.

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. ↩

gemini-code-assist

Code Review

This pull request introduces two new documentation files for migrating data to TiDB Cloud Essential clusters. My review focuses on improving clarity, consistency, and adherence to the documentation style guide. The feedback includes correcting links to ensure they point to the appropriate 'Essential' cluster documentation, standardizing terminology for supported data sources and connectivity methods across both documents, fixing minor formatting issues such as non-breaking spaces and hyphens, and enhancing the clarity of several instructions to improve the user experience.