-
Notifications
You must be signed in to change notification settings - Fork 710
cloud: add migration docs for TiDB Cloud Essential #21849
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: release-8.5
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @xuanyu66, 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 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
Using Gemini Code AssistThe 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
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 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
|
0f27069 to
8a0992f
Compare
There was a problem hiding this 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 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.
tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
e84c9bc to
a8035ba
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds comprehensive documentation for migrating data from MySQL-compatible databases to TiDB Cloud Essential using the Data Migration feature. The documentation covers both full migration (existing + incremental data) and incremental-only migration scenarios.
Changes:
- Added a comprehensive guide for migrating both existing and incremental data from MySQL-compatible databases to TiDB Cloud Essential
- Added a focused guide for migrating only incremental data from MySQL-compatible databases to TiDB Cloud Essential
- Updated the TOC to include the two new migration documents
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
tidb-cloud/migrate-from-mysql-using-data-migration-essential.md |
Main migration guide covering prerequisites, configuration, and step-by-step instructions for migrating existing and incremental data |
tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration-essential.md |
Focused guide for incremental-only data migration with specific limitations and prerequisites |
TOC-tidb-cloud-essential.md |
Added entries for both new migration documents in the table of contents |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
|
[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 |
tidb-cloud/migrate-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
| - During incremental data migration, if the table to be migrated already exists in the target database with duplicate keys, an error is reported and the migration is interrupted. In this situation, you need to verify that the MySQL source data is accurate. If it is, click the **Restart** button of the migration job, and the migration job will replace the conflicting records in the target cluster with the MySQL source records. | ||
|
|
||
| - During incremental replication (migrating ongoing changes to your cluster), if the migration job recovers from an abrupt error, it might open the safe mode for 60 seconds. During the safe mode, `INSERT` statements are migrated as `REPLACE`, `UPDATE` statements as `DELETE` and `REPLACE`, and then these transactions are migrated to the target TiDB Cloud cluster to ensure that all the data during the abrupt error has been migrated smoothly to the target TiDB Cloud cluster. In this scenario, for MySQL source tables without primary keys or non-null unique indexes, some data might be duplicated in the target TiDB Cloud cluster because the data might be inserted repeatedly into the target TiDB Cloud cluster. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
incremental replication 和 incremental data migration 有区别么?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
没有区别吧
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
tidb-cloud/migrate-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration-essential.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Grace Cai <[email protected]>
tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Grace Cai <[email protected]>
Co-authored-by: Grace Cai <[email protected]>
| </CustomContent> | ||
| <CustomContent plan="essential"> | ||
|
|
||
| - If **Public IP** is selected, fill in the **Hostname or IP address** field with the hostname or IP address of the data source. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - If **Public IP** is selected, fill in the **Hostname or IP address** field with the hostname or IP address of the data source. | |
| - If **Public** is selected, fill in the **Hostname or IP address** field with the hostname or IP address of the data source. |
| ### Availability | ||
|
|
||
| - The Data Migration feature is available only for **TiDB Cloud Dedicated** clusters. | ||
| - Currently, the Data Migration features is not available for {{{ .starter }}}. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - Currently, the Data Migration features is not available for {{{ .starter }}}. | |
| - Currently, the Data Migration feature is not available for {{{ .starter }}}. |
| 4. After applying the changes (and restarting if needed), connect to the instance and run the `SHOW VARIABLES` statement in this section to verify the configuration. | ||
| For detailed instructions, see [Set instance parameters](https://www.alibabacloud.com/help/en/rds/apsaradb-rds-for-mysql/modify-the-parameters-of-an-apsaradb-rds-for-mysql-instance) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| For detailed instructions, see [Set instance parameters](https://www.alibabacloud.com/help/en/rds/apsaradb-rds-for-mysql/modify-the-parameters-of-an-apsaradb-rds-for-mysql-instance) | |
| For more information, see [Set instance parameters](https://www.alibabacloud.com/help/en/rds/apsaradb-rds-for-mysql/modify-the-parameters-of-an-apsaradb-rds-for-mysql-instance). |
| > The egress IP range for your firewall is available only during Data Migration task creation. You cannot obtain this IP range in advance. Before you begin, ensure that you: | ||
| > | ||
| > - Have permissions to modify firewall rules. | ||
| > - Can access to your cloud provider's console during the setup process. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| > - Can access to your cloud provider's console during the setup process. | |
| > - Can access your cloud provider's console during the setup process. |
|
|
||
| ## Step 5: Precheck | ||
|
|
||
| On the **Precheck** page, you can view the precheck results. If the precheck fails, you need to operate according to **Failed** or **Warning** details, and then click **Check again** to recheck. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| On the **Precheck** page, you can view the precheck results. If the precheck fails, you need to operate according to **Failed** or **Warning** details, and then click **Check again** to recheck. | |
| On the **Precheck** page, you can view the precheck results. If the precheck fails, you need to resolve the issues according to the **Failed** or **Warning** details, and then click **Check again** to recheck. |
| - **Data source**: the data source type. | ||
| - **Region**: the region of the data source, which is required for cloud databases only. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - **Data source**: the data source type. | |
| - **Region**: the region of the data source, which is required for cloud databases only. | |
| - **Data source**: the data source type. | |
| - **Region**: the region of the data source, which is required for cloud databases only. |
| - **Connectivity method**: the connection method for the data source. <CustomContent plan="dedicated">Currently, you can choose public IP, VPC Peering, or Private Link according to your connection method.</CustomContent><CustomContent plan="essential">You can choose public IP or Private Link according to your connection method.</CustomContent> | ||
|
|
||
| <CustomContent plan="dedicated"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - **Connectivity method**: the connection method for the data source. <CustomContent plan="dedicated">Currently, you can choose public IP, VPC Peering, or Private Link according to your connection method.</CustomContent><CustomContent plan="essential">You can choose public IP or Private Link according to your connection method.</CustomContent> | |
| <CustomContent plan="dedicated"> | |
| - **Connectivity method**: the connection method for the data source. <CustomContent plan="dedicated">Currently, you can choose public IP, VPC Peering, or Private Link according to your connection method.</CustomContent><CustomContent plan="essential">You can choose public IP or Private Link according to your connection method.</CustomContent> | |
| <CustomContent plan="dedicated"> |
| - **Hostname or IP address** (for public IP and VPC Peering): the hostname or IP address of the data source. | ||
| - **Service Name** (for Private Link): the endpoint service name. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - **Hostname or IP address** (for public IP and VPC Peering): the hostname or IP address of the data source. | |
| - **Service Name** (for Private Link): the endpoint service name. | |
| - **Hostname or IP address** (for public IP and VPC Peering): the hostname or IP address of the data source. | |
| - **Service Name** (for Private Link): the endpoint service name. |
| </CustomContent> | ||
| <CustomContent plan="essential"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| </CustomContent> | |
| <CustomContent plan="essential"> | |
| </CustomContent> | |
| <CustomContent plan="essential"> |
| - **Hostname or IP address** (for public IP): the hostname or IP address of the data source. | ||
| - **Private Link Connection** (for Private Link): the private link connection that you created in the [Private Link Connections](/tidb-cloud/serverless-private-link-connection.md) section. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - **Hostname or IP address** (for public IP): the hostname or IP address of the data source. | |
| - **Private Link Connection** (for Private Link): the private link connection that you created in the [Private Link Connections](/tidb-cloud/serverless-private-link-connection.md) section. | |
| - **Hostname or IP address** (for public IP): the hostname or IP address of the data source. | |
| - **Private Link Connection** (for Private Link): the private link connection that you created in the [Private Link Connections](/tidb-cloud/serverless-private-link-connection.md) section. |
| - **Hostname or IP address** (for public IP): the hostname or IP address of the data source. | ||
| - **Private Link Connection** (for Private Link): the private link connection that you created in the [Private Link Connections](/tidb-cloud/serverless-private-link-connection.md) section. | ||
|
|
||
| </CustomContent> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| </CustomContent> | |
| </CustomContent> |
| - **Port**: the port of the data source. | ||
| - **Username**: the username of the data source. | ||
| - **Password**: the password of the username. | ||
| - **SSL/TLS**: if you enable SSL/TLS, you need to upload the certificates of the data source, including any of the following: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - **Port**: the port of the data source. | |
| - **Username**: the username of the data source. | |
| - **Password**: the password of the username. | |
| - **SSL/TLS**: if you enable SSL/TLS, you need to upload the certificates of the data source, including any of the following: | |
| - **Port**: the port of the data source. | |
| - **Username**: the username of the data source. | |
| - **Password**: the password of the username. | |
| - **SSL/TLS**: if you enable SSL/TLS, you need to upload the certificates of the data source, including any of the following: |
First-time contributors' checklist
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)?
Do your changes match any of the following descriptions?