From c35315472a3d044df75d026b242205e12e4b7afc Mon Sep 17 00:00:00 2001 From: Lilian Lee Date: Tue, 21 Jan 2025 17:12:08 +0800 Subject: [PATCH 1/7] Add temp.md --- temp.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 temp.md diff --git a/temp.md b/temp.md new file mode 100644 index 000000000000..af27ff4986a7 --- /dev/null +++ b/temp.md @@ -0,0 +1 @@ +This is a test file. \ No newline at end of file From 60ad437871988442984ea3edf1bff98463bf7972 Mon Sep 17 00:00:00 2001 From: Lilian Lee Date: Tue, 21 Jan 2025 17:12:12 +0800 Subject: [PATCH 2/7] Delete temp.md --- temp.md | 1 - 1 file changed, 1 deletion(-) delete mode 100644 temp.md diff --git a/temp.md b/temp.md deleted file mode 100644 index af27ff4986a7..000000000000 --- a/temp.md +++ /dev/null @@ -1 +0,0 @@ -This is a test file. \ No newline at end of file From fa42b5b6ed5aa116e2964b64f90641a6d4a196d4 Mon Sep 17 00:00:00 2001 From: lilin90 Date: Wed, 22 Jan 2025 16:24:21 +0800 Subject: [PATCH 3/7] dm, toc: update part of DM quick start --- TOC.md | 2 +- dm/quick-start-with-dm.md | 485 ++++++++++++++++++++++++++++++-------- 2 files changed, 390 insertions(+), 97 deletions(-) diff --git a/TOC.md b/TOC.md index 3dfe09f8cc61..f90e36ab7995 100644 --- a/TOC.md +++ b/TOC.md @@ -499,7 +499,7 @@ - TiDB Data Migration - [关于 Data Migration](/dm/dm-overview.md) - [架构简介](/dm/dm-arch.md) - - [快速开始](/dm/quick-start-with-dm.md) + - [快速上手](/dm/quick-start-with-dm.md) - [最佳实践](/dm/dm-best-practices.md) - 部署 DM 集群 - [软硬件要求](/dm/dm-hardware-and-software-requirements.md) diff --git a/dm/quick-start-with-dm.md b/dm/quick-start-with-dm.md index ef45960e5015..532127b4f995 100644 --- a/dm/quick-start-with-dm.md +++ b/dm/quick-start-with-dm.md @@ -1,183 +1,476 @@ --- title: TiDB Data Migration 快速上手指南 -summary: 了解如何快速上手部署试用 TiDB Data Migration 工具。 +summary: 了解如何使用 TiUP Playground 快速部署试用 TiDB Data Migration 工具。 aliases: ['/docs-cn/tidb-data-migration/dev/quick-start-with-dm/','/docs-cn/tidb-data-migration/dev/get-started/'] --- # TiDB Data Migration 快速上手指南 -本文介绍如何快速体验使用数据迁移工具 [TiDB Data Migration (DM)](/dm/dm-overview.md) 从 MySQL 迁移数据到 TiDB。此文档用于快速体验 DM 产品功能特性，并不建议适合在生产环境中使用。 +[TiDB Data Migration (DM)](/dm/dm-overview.md) 是一个强大的数据迁移工具，用于将数据从兼容 MySQL 的数据库迁移到 TiDB。本指南将介绍如何使用 [TiUP Playground](/tiup/tiup-playground.md) 在本地快速搭建 TiDB DM 环境，以用于开发和测试。 > **注意：** > -> 如果目标服务器的操作系统支持 SELinux，请确保 SELinux 已禁用。 +> 对于生产环境部署，请参阅[使用 TiUP 部署 DM 集群](/dm/deploy-a-dm-cluster-using-tiup.md)。 -## 第 1 步：部署 DM 集群 +## 第 1 步：搭建测试环境 -1. 安装 TiUP 工具并通过 TiUP 快速部署 [dmctl](/dm/dmctl-introduction.md)。 +[TiUP](/tiup/tiup-overview.md) 是一个集群运维工具。使用它的 Playground 可以快速启动一个用于开发和测试的临时本地环境，包含 TiDB 数据库和 TiDB DM。 - {{< copyable "shell-regular" >}} +1. 安装 TiUP： ```shell curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh - tiup install dm dmctl ``` -2. 生成 DM 集群最小拓扑文件。 + > **注意：** + > + > 如果你已经安装了 TiUP，请确保其版本为 v1.16.1 或更高版本，以便使用 `--dm-master` 和 `--dm-worker` 参数。如果要检查当前版本，执行以下命令： + > + > ```shell + > tiup --version + > ``` + > + > 如果要将 TiUP 升级到最新版本，执行以下命令： + > + > ```shell + > tiup update --self + > ``` - {{< copyable "shell-regular" >}} +2. 启动 TiUP Playground，TiDB 目标数据库，以及 DM 组件： + ```shell + tiup playground --dm-master 1 --dm-worker 1 --tiflash 0 --without-monitor ``` - tiup dm template + +3. 验证环境，查看输出中 TiDB 和 DM 是否已启动： + + ```text + TiDB Playground Cluster is started, enjoy! + + Connect TiDB: mysql --host 127.0.0.1 --port 4000 -u root + Connect DM: tiup dmctl --master-addr 127.0.0.1:8261 + TiDB Dashboard: http://127.0.0.1:2379/dashboard ``` -3. 复制输出的配置信息，修改 IP 地址后保存为 `topology.yaml` 文件，使用 TiUP 部署 DM 集群。 +4. 保持 `tiup playground` 在当前终端中运行，并在新终端中执行后续步骤。 + + 这个 Playground 环境提供了目标 TiDB 数据库和复制引擎（DM-master 和 DM-worker）的运行进程。它将处理的数据流为：MySQL（源）→ DM（复制引擎）→ TiDB（目标）。 + +## 第 2 步：准备源数据库（可选） - {{< copyable "shell-regular" >}} +你可以使用一个或多个 MySQL 实例作为源数据库。如果你已经有一个兼容 MySQL 的实例，请跳到[第 3 步](#第-3-步配置-tidb-dm-源)；如果没有，则按照以下步骤创建一个用于测试的实例。 + + + +
+ +你可以使用 Docker 快速部署一个 MySQL 8.0 测试实例。 + +1. 运行 MySQL 8.0 Docker 容器： ```shell - tiup dm deploy dm-test 8.5.0 topology.yaml -p + docker run --name mysql80 \ + -e MYSQL_ROOT_PASSWORD=MyPassw0rd! \ + -p 3306:3306 \ + -d mysql:8.0 ``` -## 第 2 步：准备数据源 +2. 连接到 MySQL： -你可以使用一个或多个 MySQL 实例作为上游数据源。 + ```shell + docker exec -it mysql80 mysql -uroot -pMyPassw0rd! + ``` -1. 为每一个数据源编写如下配置文件： +3. 创建一个 DM 测试专用用户，并授予必要的权限： - {{< copyable "shell-regular" >}} + ```sql + CREATE USER 'tidb-dm'@'%' + IDENTIFIED WITH mysql_native_password + BY 'MyPassw0rd!'; - ```yaml - source-id: "mysql-01" + GRANT PROCESS, BACKUP_ADMIN, RELOAD, REPLICATION SLAVE, REPLICATION CLIENT, SELECT ON *.* TO 'tidb-dm'@'%'; + ``` - from: - host: "127.0.0.1" - user: "root" - password: "fCxfQ9XKCezSzuCD0Wf5dUD+LsKegSg=" - port: 3306 +4. 创建示例数据： + + ```sql + CREATE DATABASE hello; + USE hello; + + CREATE TABLE hello_tidb ( + id INT AUTO_INCREMENT PRIMARY KEY, + name VARCHAR(50) + ); + + INSERT INTO hello_tidb (name) VALUES ('Hello World'); + + SELECT * FROM hello_tidb; ``` -2. 使用如下命令将数据源增加至 DM 集群。其中，`mysql-01.yaml` 是上一步编写的配置文件。 +
+ +
+ +在 macOS 上，你可以使用 [Homebrew](https://brew.sh) 在本地快速安装和启动 MySQL 8.0。 + +1. 更新 Homebrew 并安装 MySQL 8.0： + + ```shell + brew update + brew install mysql@8.0 + ``` - {{< copyable "shell-regular" >}} +2. 使 MySQL 命令可在系统路径中访问： - ```bash - tiup dmctl --master-addr=127.0.0.1:8261 operate-source create mysql-01.yaml # --master-addr 填写 master_servers 其中之一。 + ```shell + brew link mysql@8.0 --force ``` -若环境中并不存在可供测试的 MySQL 实例，可以使用以下方式通过 Docker 快速创建一个测试实例。步骤如下： +3. 启动 MySQL 服务： -1. 编写 MySQL 配置文件： + ```shell + brew services start mysql@8.0 + ``` - {{< copyable "shell-regular" >}} +4. 以 `root` 用户连接到 MySQL： ```shell - mkdir -p /tmp/mysqltest && cd /tmp/mysqltest + mysql -uroot + ``` + +5. 创建一个 DM 测试专用用户，并授予必要的权限： - cat > my.cnf <}} + INSERT INTO hello_tidb (name) VALUES ('Hello World'); + + SELECT * FROM hello_tidb; + ``` + +
+ +
+ +在 CentOS 等企业级 Linux 发行版上，你可以从 MySQL Yum 仓库安装 MySQL 8.0。 + +1. 下载并安装 MySQL Yum 仓库包。对于除 9 以外的 Linux 版本，必须在以下 URL 中将 `el9`（企业级 Linux 版本 9）替换为相应版本，同时保留 `mysql80` 以用于 MySQL 8.0 版本： ```shell - docker run --name mysql-01 -v /tmp/mysqltest:/etc/mysql/conf.d -e MYSQL_ROOT_PASSWORD=my-secret-pw -d -p 3306:3306 mysql:5.7 + sudo yum install -y https://dev.mysql.com/get/mysql80-community-release-el9-1.noarch.rpm ``` -3. 待 MySQL 启动后，即可连接该实例。 +2. 安装 MySQL： - > **注意：** - > - > 该命令仅适用于体验数据迁移过程，不能用于生产环境和压力测试。 + ```shell + sudo yum install -y mysql-community-server --nogpgcheck + ``` + +3. 启动 MySQL： + + ```shell + sudo systemctl start mysqld + ``` + +4. 在 MySQL 日志中找到临时 root 密码： + + ```shell + sudo grep 'temporary password' /var/log/mysqld.log + ``` + +5. 使用临时密码以 `root` 用户连接到 MySQL： + + ```shell + mysql -uroot -p + ``` + +6. 重置 `root` 密码： + + ```sql + ALTER USER 'root'@'localhost' + IDENTIFIED BY 'MyPassw0rd!'; + ``` + +7. 创建一个 DM 测试专用用户，并授予必要的权限： + + ```sql + CREATE USER 'tidb-dm'@'%' + IDENTIFIED WITH mysql_native_password + BY 'MyPassw0rd!'; + + GRANT PROCESS, BACKUP_ADMIN, RELOAD, REPLICATION SLAVE, REPLICATION CLIENT, SELECT ON *.* TO 'tidb-dm'@'%'; + ``` + +8. 创建示例数据： + + ```sql + CREATE DATABASE hello; + USE hello; + + CREATE TABLE hello_tidb ( + id INT AUTO_INCREMENT PRIMARY KEY, + name VARCHAR(50) + ); + + INSERT INTO hello_tidb (name) VALUES ('Hello World'); + + SELECT * FROM hello_tidb; + ``` + +
+ +
+ +在 Ubuntu 上，你可以从官方 Ubuntu 仓库安装 MySQL。 + +1. 更新软件包列表： + + ```shell + sudo apt-get update + ``` + +2. 安装 MySQL： + + ```shell + sudo apt-get install -y mysql-server + ``` + +3. 检查 `mysql` 服务是否在运行，必要时启动服务： + + ```shell + sudo systemctl status mysql + sudo systemctl start mysql + ``` - {{< copyable "shell-regular" >}} +4. 使用 socket 认证以 `root` 用户连接到 MySQL： ```shell - mysql -uroot -p -h 127.0.0.1 -P 3306 + sudo mysql + ``` + +5. 创建一个 DM 测试专用用户，并授予必要的权限： + + ```sql + CREATE USER 'tidb-dm'@'%' + IDENTIFIED WITH mysql_native_password + BY 'MyPassw0rd!'; + + GRANT PROCESS, BACKUP_ADMIN, RELOAD, REPLICATION SLAVE, REPLICATION CLIENT, SELECT ON *.* TO 'tidb-dm'@'%'; + ``` + +6. 创建示例数据： + + ```sql + CREATE DATABASE hello; + USE hello; + + CREATE TABLE hello_tidb ( + id INT AUTO_INCREMENT PRIMARY KEY, + name VARCHAR(50) + ); + + INSERT INTO hello_tidb (name) VALUES ('Hello World'); + + SELECT * FROM hello_tidb; ``` -## 第 3 步：准备下游数据库 +
-可以选择已存在的 TiDB 集群作为数据同步目标。 + -如果没有可以用于测试的 TiDB 集群，则使用以下命令快速构建演示环境。 +## 第 3 步：配置 TiDB DM 源 -{{< copyable "shell-regular" >}} +After preparing the source MySQL database, configure TiDB DM to connect to it. To do this, create a source configuration file with the connection details and apply the configuration using the `dmctl` tool. -```shell -tiup playground -``` +1. Create a source configuration file `mysql-01.yaml`: -## 第 4 步：准备测试数据 + > **Note:** + > + > This step assumes you have already created the `tidb-dm` user with replication privileges in the source database, as described in [Step 2](#step-2-prepare-a-source-database-optional). -在一个或多个数据源中创建测试表和数据。如果你使用已存在的 MySQL 数据库，且数据库中已有可用数据，可跳过这一步。 + ```yaml + source-id: "mysql-01" + from: + host: "127.0.0.1" + user: "tidb-dm" + password: "MyPassw0rd!" # In production environments, it is recommended to use a password encrypted with dmctl. + port: 3306 + ``` -{{< copyable "sql" >}} +2. Create a DM data source: -```sql -drop database if exists `testdm`; -create database `testdm`; -use `testdm`; -create table t1 (id bigint, uid int, name varchar(80), info varchar(100), primary key (`id`), unique key(`uid`)) DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin; -create table t2 (id bigint, uid int, name varchar(80), info varchar(100), primary key (`id`), unique key(`uid`)) DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin; -insert into t1 (id, uid, name) values (1, 10001, 'Gabriel García Márquez'), (2, 10002, 'Cien años de soledad'); -insert into t2 (id, uid, name) values (3, 20001, 'José Arcadio Buendía'), (4, 20002, 'Úrsula Iguarán'), (5, 20003, 'José Arcadio'); -``` + ```shell + tiup dmctl --master-addr 127.0.0.1:8261 operate-source create mysql-01.yaml + ``` -## 第 5 步：编写数据同步任务 +## Step 4: Create a TiDB DM task -1. 创建任务的配置文件 `testdm-task.yaml`： +After configuring the source database, you can create a migration task in TiDB DM. This task references the source MySQL instance and defines the connection details for the target TiDB database. - {{< copyable "" >}} +1. Create a DM task configuration file `tiup-playground-task.yaml`: ```yaml - name: testdm - task-mode: all + # Task + name: tiup-playground-task + task-mode: "all" # Execute all phases - full data migration and incremental sync. + + # Source (MySQL) + mysql-instances: + - source-id: "mysql-01" + ## Target (TiDB) target-database: host: "127.0.0.1" port: 4000 user: "root" - password: "" # 如果密码不为空，则推荐使用经过 dmctl 加密的密文 + password: "" # If the password is not empty, it is recommended to use a password encrypted with dmctl. + ``` - # 填写一个或多个所需同步的数据源信息 - mysql-instances: - - source-id: "mysql-01" - block-allow-list: "ba-rule1" +2. Start the task using the configuration file: + + ```shell + tiup dmctl --master-addr 127.0.0.1:8261 start-task tiup-playground-task.yaml + ``` - block-allow-list: - ba-rule1: - do-dbs: ["testdm"] +## Step 5: Verify the data replication + +After starting the migration task, verify whether data replication is working as expected. Use the `dmctl` tool to check the task status, and connect to the target TiDB database to confirm that the data has been successfully replicated from the source MySQL database. + +1. Check the status of the TiDB DM task: + + ```shell + tiup dmctl --master-addr 127.0.0.1:8261 query-status ``` -2. 使用 dmctl 创建任务： +2. Connect to the TiDB target database: - {{< copyable "shell-regular" >}} + ```shell + mysql --host 127.0.0.1 --port 4000 -u root --prompt 'tidb> ' + ``` - ```bash - tiup dmctl --master-addr 127.0.0.1:8261 start-task testdm-task.yaml +3. Verify the replicated data. If you have created the sample data in [Step 2](#step-2-prepare-a-source-database-optional), you will see the `hello_tidb` table replicated from the MySQL source database to the TiDB target database: + + ```sql + SELECT * FROM hello.hello_tidb; ``` -这样就成功创建了一个将 `mysql-01` 数据源迁移到 TiDB 的任务。 + The output is as follows: + + ```sql + +----+-------------+ + | id | name | + +----+-------------+ + | 1 | Hello World | + +----+-------------+ + 1 row in set (0.00 sec) + ``` + +## Step 6: Clean up (optional) + +After completing your testing, you can clean up the environment by stopping the TiUP Playground, removing the source MySQL instance (if created for testing), and deleting unnecessary files. -## 第 6 步：查看迁移任务状态 +1. Stop the TiUP Playground: + + In the terminal where the TiUP Playground is running, press Control+C to terminate the process. This stops all TiDB and DM components and deletes the target environment. + +2. Stop and remove the source MySQL instance: + + If you have created a source MySQL instance for testing in [Step 2](#step-2-prepare-a-source-database-optional), stop and remove it by taking the following steps: + + + +
+ + To stop and remove the Docker container: + + ```shell + docker stop mysql80 + docker rm mysql80 + ``` + +
+ +
+ + If you installed MySQL 8.0 using Homebrew solely for testing, stop the service and uninstall it: + + ```shell + brew services stop mysql@8.0 + brew uninstall mysql@8.0 + ``` + + > **Note:** + > + > If you want to remove all MySQL data files, delete the MySQL data directory (commonly located at `/opt/homebrew/var/mysql`). + +
+ +
+ + If you installed MySQL 8.0 from the MySQL Yum repository, stop the service and uninstall it: + + ```shell + sudo systemctl stop mysqld + sudo yum remove -y mysql-community-server + ``` + + > **Note:** + > + > If you want to remove all MySQL data files, delete the MySQL data directory (commonly located at `/var/lib/mysql`). + +
+ +
+ + If you installed MySQL from the official Ubuntu repository, stop the service and uninstall it: + + ```shell + sudo systemctl stop mysql + sudo apt-get remove --purge -y mysql-server + sudo apt-get autoremove -y + ``` + + > **Note:** + > + > If you want to remove all MySQL data files, delete the MySQL data directory (commonly located at `/var/lib/mysql`). + +
+ + + +3. Remove the TiDB DM configuration files if they are no longer needed: + + ```shell + rm mysql-01.yaml tiup-playground-task.yaml + ``` + +4. If you no longer need TiUP, you can uninstall it: + + ```shell + rm -rf ~/.tiup + ``` -在创建迁移任务之后，可以用 `dmctl query-status` 来查看任务的状态。 +## What's next -{{< copyable "shell-regular" >}} +Now that you successfully created a task that migrates data from a source MySQL database to a target TiDB in a testing environment, you can: -```bash -tiup dmctl --master-addr 127.0.0.1:8261 query-status testdm -``` +- Explore [TiDB DM Features](/dm/dm-overview.md) +- Learn about [TiDB DM Architecture](/dm/dm-arch.md) +- Set up [TiDB DM for a Proof of Concept or Production](/dm/deploy-a-dm-cluster-using-tiup.md) +- Configure advanced [DM Tasks](/dm/dm-task-configuration-guide.md) From d6ca9316bb6cf70dd756e8c1833ace39ab9c2e8a Mon Sep 17 00:00:00 2001 From: lilin90 Date: Wed, 22 Jan 2025 17:56:31 +0800 Subject: [PATCH 4/7] dm: finish steps --- dm/quick-start-with-dm.md | 80 +++++++++++++++++++-------------------- 1 file changed, 40 insertions(+), 40 deletions(-) diff --git a/dm/quick-start-with-dm.md b/dm/quick-start-with-dm.md index 532127b4f995..3517fe20cf65 100644 --- a/dm/quick-start-with-dm.md +++ b/dm/quick-start-with-dm.md @@ -54,7 +54,7 @@ aliases: ['/docs-cn/tidb-data-migration/dev/quick-start-with-dm/','/docs-cn/tidb 4. 保持 `tiup playground` 在当前终端中运行，并在新终端中执行后续步骤。 - 这个 Playground 环境提供了目标 TiDB 数据库和复制引擎（DM-master 和 DM-worker）的运行进程。它将处理的数据流为：MySQL（源）→ DM（复制引擎）→ TiDB（目标）。 + 这个 Playground 环境提供了目标 TiDB 数据库和数据复制引擎（DM-master 和 DM-worker）的运行进程。它将处理的数据流为：MySQL（源数据库）→ DM（数据复制引擎）→ TiDB（目标数据库）。 ## 第 2 步：准备源数据库（可选） @@ -296,13 +296,13 @@ aliases: ['/docs-cn/tidb-data-migration/dev/quick-start-with-dm/','/docs-cn/tidb ## 第 3 步：配置 TiDB DM 源 -After preparing the source MySQL database, configure TiDB DM to connect to it. To do this, create a source configuration file with the connection details and apply the configuration using the `dmctl` tool. +准备好源 MySQL 数据库后，配置 TiDB DM 连接到它。为此，创建一个包含连接详细信息的源配置文件，并使用 `dmctl` 工具应用该配置。 -1. Create a source configuration file `mysql-01.yaml`: +1. 创建源配置文件 `mysql-01.yaml`： - > **Note:** + > **注意：** > - > This step assumes you have already created the `tidb-dm` user with replication privileges in the source database, as described in [Step 2](#step-2-prepare-a-source-database-optional). + > 这里假设你已经在源数据库中创建了具有数据复制权限的 `tidb-dm` 用户，如[第 2 步](#第-2-步准备源数据库可选)所述。 ```yaml source-id: "mysql-01" @@ -313,17 +313,17 @@ After preparing the source MySQL database, configure TiDB DM to connect to it. T port: 3306 ``` -2. Create a DM data source: +2. 创建 DM 数据源： ```shell tiup dmctl --master-addr 127.0.0.1:8261 operate-source create mysql-01.yaml ``` -## Step 4: Create a TiDB DM task +## 第 4 步：创建 TiDB DM 任务 -After configuring the source database, you can create a migration task in TiDB DM. This task references the source MySQL instance and defines the connection details for the target TiDB database. +配置好源数据库后，在 TiDB DM 中创建一个迁移任务，指定 MySQL 实例作为数据源，并定义目标数据库 TiDB 的详细连接信息。 -1. Create a DM task configuration file `tiup-playground-task.yaml`: +1. 创建 DM 任务配置文件 `tiup-playground-task.yaml`： ```yaml # Task @@ -342,35 +342,35 @@ After configuring the source database, you can create a migration task in TiDB D password: "" # If the password is not empty, it is recommended to use a password encrypted with dmctl. ``` -2. Start the task using the configuration file: +2. 使用配置文件启动任务： ```shell tiup dmctl --master-addr 127.0.0.1:8261 start-task tiup-playground-task.yaml ``` -## Step 5: Verify the data replication +## 第 5 步：验证迁移数据 -After starting the migration task, verify whether data replication is working as expected. Use the `dmctl` tool to check the task status, and connect to the target TiDB database to confirm that the data has been successfully replicated from the source MySQL database. +启动数据迁移任务后，验证数据复制是否符合预期。使用 `dmctl` 工具检查任务状态，并连接到目标数据库 TiDB，确认数据是否已成功从源数据库 MySQL 复制到了目标数据库 TiDB。 -1. Check the status of the TiDB DM task: +1. 检查 TiDB DM 任务的状态： ```shell tiup dmctl --master-addr 127.0.0.1:8261 query-status ``` -2. Connect to the TiDB target database: +2. 连接到目标数据库 TiDB： ```shell mysql --host 127.0.0.1 --port 4000 -u root --prompt 'tidb> ' ``` -3. Verify the replicated data. If you have created the sample data in [Step 2](#step-2-prepare-a-source-database-optional), you will see the `hello_tidb` table replicated from the MySQL source database to the TiDB target database: +3. 验证迁移的数据。如果在[第 2 步](#第-2-步准备源数据库可选)中创建了示例数据，你将看到从源数据库 MySQL 复制到目标数据库 TiDB 的 `hello_tidb` 表： ```sql SELECT * FROM hello.hello_tidb; ``` - The output is as follows: + 输出如下： ```sql +----+-------------+ @@ -381,23 +381,23 @@ After starting the migration task, verify whether data replication is working as 1 row in set (0.00 sec) ``` -## Step 6: Clean up (optional) +## 第 6 步：清理环境（可选） -After completing your testing, you can clean up the environment by stopping the TiUP Playground, removing the source MySQL instance (if created for testing), and deleting unnecessary files. +测试完成后，可以清理环境，包括关闭 TiUP Playground、移除 MySQL 实例数据源（如果是专为测试创建的），以及删除不必要的文件。 -1. Stop the TiUP Playground: +1. 停止 TiUP Playground： - In the terminal where the TiUP Playground is running, press Control+C to terminate the process. This stops all TiDB and DM components and deletes the target environment. + 在运行 TiUP Playground 的终端中，按 Control+C 终止进程。这将停止所有的 TiDB 和 DM 组件，并删除目标数据库环境。 -2. Stop and remove the source MySQL instance: +2. 停止和删除数据源 MySQL 实例： - If you have created a source MySQL instance for testing in [Step 2](#step-2-prepare-a-source-database-optional), stop and remove it by taking the following steps: + 如果你在[第 2 步](#第-2-步准备源数据库可选)中为测试创建了 MySQL 实例作为数据源，可按以下步骤将其停止和删除：
- To stop and remove the Docker container: + 停止和删除 Docker 容器： ```shell docker stop mysql80 @@ -408,37 +408,37 @@ After completing your testing, you can clean up the environment by stopping the
- If you installed MySQL 8.0 using Homebrew solely for testing, stop the service and uninstall it: + 如果你使用 Homebrew 安装的 MySQL 8.0 仅用于测试，则停止服务并卸载： ```shell brew services stop mysql@8.0 brew uninstall mysql@8.0 ``` - > **Note:** + > **注意：** > - > If you want to remove all MySQL data files, delete the MySQL data directory (commonly located at `/opt/homebrew/var/mysql`). + > 如果你要删除所有 MySQL 数据文件，则删除 MySQL 数据目录（通常位于 `/opt/homebrew/var/mysql`）。
- If you installed MySQL 8.0 from the MySQL Yum repository, stop the service and uninstall it: + 如果你从 MySQL Yum 仓库安装的 MySQL 8.0 仅用于测试，则停止服务并卸载： ```shell sudo systemctl stop mysqld sudo yum remove -y mysql-community-server ``` - > **Note:** + > **注意：** > - > If you want to remove all MySQL data files, delete the MySQL data directory (commonly located at `/var/lib/mysql`). + > 如果你要删除所有 MySQL 数据文件，则删除 MySQL 数据目录（通常位于 `/var/lib/mysql`）。
- If you installed MySQL from the official Ubuntu repository, stop the service and uninstall it: + 如果你从官方 Ubuntu 仓库安装的 MySQL 仅用于测试，则停止服务并卸载： ```shell sudo systemctl stop mysql @@ -446,31 +446,31 @@ After completing your testing, you can clean up the environment by stopping the sudo apt-get autoremove -y ``` - > **Note:** + > **注意：** > - > If you want to remove all MySQL data files, delete the MySQL data directory (commonly located at `/var/lib/mysql`). + > 如果你要删除所有 MySQL 数据文件，则删除 MySQL 数据目录（通常位于 `/var/lib/mysql`）。
-3. Remove the TiDB DM configuration files if they are no longer needed: +3. 如果不再需要 TiDB DM 配置文件，则删除： ```shell rm mysql-01.yaml tiup-playground-task.yaml ``` -4. If you no longer need TiUP, you can uninstall it: +4. 如果不再需要 TiUP，则卸载： ```shell rm -rf ~/.tiup ``` -## What's next +## 探索更多 -Now that you successfully created a task that migrates data from a source MySQL database to a target TiDB in a testing environment, you can: +现在，你已经成功在测试环境中完成了一个从源数据库 MySQL 迁移数据到目标数据库 TiDB 的任务，接下来可以： -- Explore [TiDB DM Features](/dm/dm-overview.md) -- Learn about [TiDB DM Architecture](/dm/dm-arch.md) -- Set up [TiDB DM for a Proof of Concept or Production](/dm/deploy-a-dm-cluster-using-tiup.md) -- Configure advanced [DM Tasks](/dm/dm-task-configuration-guide.md) +- 探索 [TiDB DM 的特性](/dm/dm-overview.md) +- 了解 [TiDB DM 的架构](/dm/dm-arch.md) +- [在生产环境中部署 TiDB DM 集群](/dm/deploy-a-dm-cluster-using-tiup.md) +- 了解 [TiDB DM 数据迁移任务的高级配置](/dm/dm-task-configuration-guide.md) From 02b212bfb9670f3acea6e9151826b6a5f46c6964 Mon Sep 17 00:00:00 2001 From: Lilian Lee Date: Thu, 23 Jan 2025 13:53:47 +0800 Subject: [PATCH 5/7] Apply suggestions from code review Co-authored-by: Aolin --- dm/quick-start-with-dm.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/dm/quick-start-with-dm.md b/dm/quick-start-with-dm.md index 3517fe20cf65..a06562eef631 100644 --- a/dm/quick-start-with-dm.md +++ b/dm/quick-start-with-dm.md @@ -24,7 +24,7 @@ aliases: ['/docs-cn/tidb-data-migration/dev/quick-start-with-dm/','/docs-cn/tidb > **注意：** > - > 如果你已经安装了 TiUP，请确保其版本为 v1.16.1 或更高版本，以便使用 `--dm-master` 和 `--dm-worker` 参数。如果要检查当前版本，执行以下命令： + > 如果你已经安装了 TiUP，请确保其版本为 v1.16.1 或之后版本，以便使用 `--dm-master` 和 `--dm-worker` 参数。如果要检查当前版本，执行以下命令： > > ```shell > tiup --version @@ -36,7 +36,7 @@ aliases: ['/docs-cn/tidb-data-migration/dev/quick-start-with-dm/','/docs-cn/tidb > tiup update --self > ``` -2. 启动 TiUP Playground，TiDB 目标数据库，以及 DM 组件： +2. 启动包含目标数据库 TiDB 和 DM 组件的 TiUP Playground： ```shell tiup playground --dm-master 1 --dm-worker 1 --tiflash 0 --without-monitor @@ -58,7 +58,7 @@ aliases: ['/docs-cn/tidb-data-migration/dev/quick-start-with-dm/','/docs-cn/tidb ## 第 2 步：准备源数据库（可选） -你可以使用一个或多个 MySQL 实例作为源数据库。如果你已经有一个兼容 MySQL 的实例，请跳到[第 3 步](#第-3-步配置-tidb-dm-源)；如果没有，则按照以下步骤创建一个用于测试的实例。 +你可以使用一个或多个 MySQL 实例作为源数据库。如果你已经有一个兼容 MySQL 的实例，请跳到[第 3 步](#第-3-步配置-tidb-dm-源)；如果没有，则按照以下步骤创建一个用于测试的 MySQL 实例。 @@ -81,7 +81,7 @@ aliases: ['/docs-cn/tidb-data-migration/dev/quick-start-with-dm/','/docs-cn/tidb docker exec -it mysql80 mysql -uroot -pMyPassw0rd! ``` -3. 创建一个 DM 测试专用用户，并授予必要的权限： +3. 创建一个 DM 测试专用用户，并授予测试所需的权限： ```sql CREATE USER 'tidb-dm'@'%' @@ -120,7 +120,7 @@ aliases: ['/docs-cn/tidb-data-migration/dev/quick-start-with-dm/','/docs-cn/tidb brew install mysql@8.0 ``` -2. 使 MySQL 命令可在系统路径中访问： +2. 将 MySQL 命令添加到系统路径中： ```shell brew link mysql@8.0 --force @@ -170,7 +170,7 @@ aliases: ['/docs-cn/tidb-data-migration/dev/quick-start-with-dm/','/docs-cn/tidb 在 CentOS 等企业级 Linux 发行版上，你可以从 MySQL Yum 仓库安装 MySQL 8.0。 -1. 下载并安装 MySQL Yum 仓库包。对于除 9 以外的 Linux 版本，必须在以下 URL 中将 `el9`（企业级 Linux 版本 9）替换为相应版本，同时保留 `mysql80` 以用于 MySQL 8.0 版本： +1. 从 [MySQL Yum 仓库下载页面](https://dev.mysql.com/downloads/repo/yum)下载并安装 MySQL Yum 仓库包。对于非 Linux 9 版本，你需要将以下 URL 中的 `el9`（企业级 Linux 9 版本）替换为相应版本，同时保留 `mysql80` 以用于 MySQL 8.0 版本： ```shell sudo yum install -y https://dev.mysql.com/get/mysql80-community-release-el9-1.noarch.rpm @@ -207,7 +207,7 @@ aliases: ['/docs-cn/tidb-data-migration/dev/quick-start-with-dm/','/docs-cn/tidb IDENTIFIED BY 'MyPassw0rd!'; ``` -7. 创建一个 DM 测试专用用户，并授予必要的权限： +7. 创建一个 DM 测试专用用户，并授予测试所需的权限： ```sql CREATE USER 'tidb-dm'@'%' @@ -264,7 +264,7 @@ aliases: ['/docs-cn/tidb-data-migration/dev/quick-start-with-dm/','/docs-cn/tidb sudo mysql ``` -5. 创建一个 DM 测试专用用户，并授予必要的权限： +5. 创建一个 DM 测试专用用户，并授予测试所需的权限： ```sql CREATE USER 'tidb-dm'@'%' @@ -348,7 +348,7 @@ aliases: ['/docs-cn/tidb-data-migration/dev/quick-start-with-dm/','/docs-cn/tidb tiup dmctl --master-addr 127.0.0.1:8261 start-task tiup-playground-task.yaml ``` -## 第 5 步：验证迁移数据 +## 第 5 步：验证数据复制 启动数据迁移任务后，验证数据复制是否符合预期。使用 `dmctl` 工具检查任务状态，并连接到目标数据库 TiDB，确认数据是否已成功从源数据库 MySQL 复制到了目标数据库 TiDB。 @@ -383,21 +383,21 @@ aliases: ['/docs-cn/tidb-data-migration/dev/quick-start-with-dm/','/docs-cn/tidb ## 第 6 步：清理环境（可选） -测试完成后，可以清理环境，包括关闭 TiUP Playground、移除 MySQL 实例数据源（如果是专为测试创建的），以及删除不必要的文件。 +测试完成后，可以清理环境，包括停止 TiUP Playground、删除 MySQL 实例数据源（如果是专为测试创建的），以及删除不必要的文件。 1. 停止 TiUP Playground： 在运行 TiUP Playground 的终端中，按 Control+C 终止进程。这将停止所有的 TiDB 和 DM 组件，并删除目标数据库环境。 -2. 停止和删除数据源 MySQL 实例： +2. 停止并删除数据源 MySQL 实例： - 如果你在[第 2 步](#第-2-步准备源数据库可选)中为测试创建了 MySQL 实例作为数据源，可按以下步骤将其停止和删除： + 如果你在[第 2 步](#第-2-步准备源数据库可选)中为测试创建了 MySQL 实例作为数据源，可按以下步骤停止并删除它：
- 停止和删除 Docker 容器： + 停止并删除 Docker 容器： ```shell docker stop mysql80 From 1e86531cb4064fece3fcd5ba23b15d1535c48538 Mon Sep 17 00:00:00 2001 From: lilin90 Date: Thu, 23 Jan 2025 14:11:22 +0800 Subject: [PATCH 6/7] Update wording --- dm/quick-start-with-dm.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/dm/quick-start-with-dm.md b/dm/quick-start-with-dm.md index a06562eef631..145a3a48c70e 100644 --- a/dm/quick-start-with-dm.md +++ b/dm/quick-start-with-dm.md @@ -6,7 +6,7 @@ aliases: ['/docs-cn/tidb-data-migration/dev/quick-start-with-dm/','/docs-cn/tidb # TiDB Data Migration 快速上手指南 -[TiDB Data Migration (DM)](/dm/dm-overview.md) 是一个强大的数据迁移工具，用于将数据从兼容 MySQL 的数据库迁移到 TiDB。本指南将介绍如何使用 [TiUP Playground](/tiup/tiup-playground.md) 在本地快速搭建 TiDB DM 环境，以用于开发和测试。 +[TiDB Data Migration (DM)](/dm/dm-overview.md) 是一个强大的数据迁移工具，用于将数据从兼容 MySQL 的数据库迁移到 TiDB。本指南介绍如何使用 [TiUP Playground](/tiup/tiup-playground.md) 在本地快速搭建用于开发或测试的 TiDB DM 环境，并完成一个将数据从源数据库 MySQL 迁移到目标数据库 TiDB 的简单任务。 > **注意：** > @@ -348,9 +348,9 @@ aliases: ['/docs-cn/tidb-data-migration/dev/quick-start-with-dm/','/docs-cn/tidb tiup dmctl --master-addr 127.0.0.1:8261 start-task tiup-playground-task.yaml ``` -## 第 5 步：验证数据复制 +## 第 5 步：验证数据迁移 -启动数据迁移任务后，验证数据复制是否符合预期。使用 `dmctl` 工具检查任务状态，并连接到目标数据库 TiDB，确认数据是否已成功从源数据库 MySQL 复制到了目标数据库 TiDB。 +启动数据迁移任务后，验证数据复制是否符合预期。使用 `dmctl` 工具检查任务状态，并连接到目标数据库 TiDB，确认数据是否已成功从源数据库 MySQL 迁移到了目标数据库 TiDB。 1. 检查 TiDB DM 任务的状态： From 0dc520e45e28d0867ad2addaad9360f548d8ca19 Mon Sep 17 00:00:00 2001 From: Lilian Lee Date: Thu, 23 Jan 2025 14:18:25 +0800 Subject: [PATCH 7/7] Update wording --- dm/quick-start-with-dm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dm/quick-start-with-dm.md b/dm/quick-start-with-dm.md index 145a3a48c70e..f1227edcefc4 100644 --- a/dm/quick-start-with-dm.md +++ b/dm/quick-start-with-dm.md @@ -1,6 +1,6 @@ --- title: TiDB Data Migration 快速上手指南 -summary: 了解如何使用 TiUP Playground 快速部署试用 TiDB Data Migration 工具。 +summary: 了解如何使用 TiUP Playground 快速部署试用 TiDB Data Migration 数据迁移工具。 aliases: ['/docs-cn/tidb-data-migration/dev/quick-start-with-dm/','/docs-cn/tidb-data-migration/dev/get-started/'] ---