+
+
+
+你可以使用 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 测试专用用户，并授予必要的权限：
+
+ ```sql
+ CREATE USER 'tidb-dm'@'%'
+ IDENTIFIED WITH mysql_native_password
+ BY 'MyPassw0rd!';
- cat > my.cnf <}}
+
+
+
+
+在 CentOS 等企业级 Linux 发行版上，你可以从 MySQL Yum 仓库安装 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
- 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` 服务是否在运行，必要时启动服务：
- {{< copyable "shell-regular" >}}
+ ```shell
+ sudo systemctl status mysql
+ sudo systemctl start mysql
+ ```
+
+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'@'%';
```
-## 第 3 步：准备下游数据库
+6. 创建示例数据：
+
+ ```sql
+ CREATE DATABASE hello;
+ USE hello;
+
+ CREATE TABLE hello_tidb (
+ id INT AUTO_INCREMENT PRIMARY KEY,
+ name VARCHAR(50)
+ );
-可以选择已存在的 TiDB 集群作为数据同步目标。
+ INSERT INTO hello_tidb (name) VALUES ('Hello World');
-如果没有可以用于测试的 TiDB 集群，则使用以下命令快速构建演示环境。
+ SELECT * FROM hello_tidb;
+ ```
-{{< copyable "shell-regular" >}}
+
-```shell
-tiup playground
-```
+
-## 第 4 步：准备测试数据
+## 第 3 步：配置 TiDB DM 源
-在一个或多个数据源中创建测试表和数据。如果你使用已存在的 MySQL 数据库，且数据库中已有可用数据，可跳过这一步。
+准备好源 MySQL 数据库后，配置 TiDB DM 连接到它。为此，创建一个包含连接详细信息的源配置文件，并使用 `dmctl` 工具应用该配置。
-{{< copyable "sql" >}}
+1. 创建源配置文件 `mysql-01.yaml`：
-```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');
-```
+ > **注意：**
+ >
+ > 这里假设你已经在源数据库中创建了具有数据复制权限的 `tidb-dm` 用户，如[第 2 步](#第-2-步准备源数据库可选)所述。
+
+ ```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
+ ```
+
+2. 创建 DM 数据源：
+
+ ```shell
+ tiup dmctl --master-addr 127.0.0.1:8261 operate-source create mysql-01.yaml
+ ```
-## 第 5 步：编写数据同步任务
+## 第 4 步：创建 TiDB DM 任务
-1. 创建任务的配置文件 `testdm-task.yaml`：
+配置好源数据库后，在 TiDB DM 中创建一个迁移任务，指定 MySQL 实例作为数据源，并定义目标数据库 TiDB 的详细连接信息。
- {{< copyable "" >}}
+1. 创建 DM 任务配置文件 `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. 使用配置文件启动任务：
+
+ ```shell
+ tiup dmctl --master-addr 127.0.0.1:8261 start-task tiup-playground-task.yaml
+ ```
+
+## 第 5 步：验证数据迁移
+
+启动数据迁移任务后，验证数据复制是否符合预期。使用 `dmctl` 工具检查任务状态，并连接到目标数据库 TiDB，确认数据是否已成功从源数据库 MySQL 迁移到了目标数据库 TiDB。
- block-allow-list:
- ba-rule1:
- do-dbs: ["testdm"]
+1. 检查 TiDB DM 任务的状态：
+
+ ```shell
+ tiup dmctl --master-addr 127.0.0.1:8261 query-status
```
-2. 使用 dmctl 创建任务：
+2. 连接到目标数据库 TiDB：
+
+ ```shell
+ mysql --host 127.0.0.1 --port 4000 -u root --prompt 'tidb> '
+ ```
- {{< copyable "shell-regular" >}}
+3. 验证迁移的数据。如果在[第 2 步](#第-2-步准备源数据库可选)中创建了示例数据，你将看到从源数据库 MySQL 复制到目标数据库 TiDB 的 `hello_tidb` 表：
- ```bash
- tiup dmctl --master-addr 127.0.0.1:8261 start-task testdm-task.yaml
+ ```sql
+ SELECT * FROM hello.hello_tidb;
```
-这样就成功创建了一个将 `mysql-01` 数据源迁移到 TiDB 的任务。
+ 输出如下：
+
+ ```sql
+ +----+-------------+
+ | id | name |
+ +----+-------------+
+ | 1 | Hello World |
+ +----+-------------+
+ 1 row in set (0.00 sec)
+ ```
+
+## 第 6 步：清理环境（可选）
+
+测试完成后，可以清理环境，包括停止 TiUP Playground、删除 MySQL 实例数据源（如果是专为测试创建的），以及删除不必要的文件。
+
+1. 停止 TiUP Playground：
+
+ 在运行 TiUP Playground 的终端中，按
+
+
+
+ 停止并删除 Docker 容器：
+
+ ```shell
+ docker stop mysql80
+ docker rm mysql80
+ ```
+
+
+
+
+
+ 如果你使用 Homebrew 安装的 MySQL 8.0 仅用于测试，则停止服务并卸载：
+
+ ```shell
+ brew services stop mysql@8.0
+ brew uninstall mysql@8.0
+ ```
+
+ > **注意：**
+ >
+ > 如果你要删除所有 MySQL 数据文件，则删除 MySQL 数据目录（通常位于 `/opt/homebrew/var/mysql`）。
+
+
+
+
+
+ 如果你从 MySQL Yum 仓库安装的 MySQL 8.0 仅用于测试，则停止服务并卸载：
+
+ ```shell
+ sudo systemctl stop mysqld
+ sudo yum remove -y mysql-community-server
+ ```
+
+ > **注意：**
+ >
+ > 如果你要删除所有 MySQL 数据文件，则删除 MySQL 数据目录（通常位于 `/var/lib/mysql`）。
+
+
+
+
+
+ 如果你从官方 Ubuntu 仓库安装的 MySQL 仅用于测试，则停止服务并卸载：
+
+ ```shell
+ sudo systemctl stop mysql
+ sudo apt-get remove --purge -y mysql-server
+ sudo apt-get autoremove -y
+ ```
+
+ > **注意：**
+ >
+ > 如果你要删除所有 MySQL 数据文件，则删除 MySQL 数据目录（通常位于 `/var/lib/mysql`）。
+
+
+
+
+
+3. 如果不再需要 TiDB DM 配置文件，则删除：
+
+ ```shell
+ rm mysql-01.yaml tiup-playground-task.yaml
+ ```
+
+4. 如果不再需要 TiUP，则卸载：
+
+ ```shell
+ rm -rf ~/.tiup
+ ```
-在创建迁移任务之后，可以用 `dmctl query-status` 来查看任务的状态。
+## 探索更多
-{{< copyable "shell-regular" >}}
+现在，你已经成功在测试环境中完成了一个从源数据库 MySQL 迁移数据到目标数据库 TiDB 的任务，接下来可以：
-```bash
-tiup dmctl --master-addr 127.0.0.1:8261 query-status testdm
-```
+- 探索 [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)