使用指南：TiDiff - SQL 对比工具

1. 项目介绍

TiDiff 是一个用于提高效率的工具，它会在 TiDB 和 MySQL 中执行相同的 SQL 语句，并对比处理结果，以突出显示差异。该工具主要适用于以下场景：

• 验证 TiDB 中的 SQL 语句是否兼容 MySQL。
• 在大量数据（例如，100万行数据）的情况下，为 MySQL 和 TiDB 生成相同的工作负载，以便于重现错误。

2. 项目快速启动

环境准备

确保已安装 Go，然后通过以下命令克隆仓库并编译 tidiff：

git clone https://github.com/pingcap/tidiff.git
cd tidiff
make build

这将在 bin 目录下生成可执行文件 tidiff。

启动 TiDB 和 MySQL

确保本地已经运行了 MySQL 和 TiDB 服务器，可以使用默认的 root 用户和空密码登录。

执行 SQL

使用 tidiff 执行 SQL 语句进行对比：

./bin/tidiff \
--mysql-host=127.0.0.1 \
--mysql-port=3306 \
--tidb-host=127.0.0.1 \
--tidb-port=4000 \
'select * from your_table'

这里替换 your_table 为你想要查询的实际表名。

3. 应用案例和最佳实践

• 兼容性检查：在迁移数据库到 TiDB 前，可以使用 TiDiff 检查 SQL 查询或存储过程的兼容性。

• 性能对比：比较相同查询在 MySQL 和 TiDB 中的执行时间和资源消耗。

• 故障排查：当在 TiDB 上遇到问题时，可以通过 TiDiff 检查是否在 MySQL 上也有相同的问题。

• 自动化测试：集成到测试框架中，验证升级版本后的 SQL 兼容性和行为一致性。

4. 典型生态项目

TiDiff 通常与其他 TiDB 生态项目一起使用，如：

• PD（Placement Driver）：TiDB 的分布式调度器。
• TiKV：分布式事务级键值存储。
• TiSpark：允许用户使用 Spark 操作 TiDB 数据。

这些项目共同构成了 TiDB 分布式数据库系统，提供了一站式的 HTAP 解决方案。

---

通过以上内容，你应该对 TiDiff 工具有了基本的认识，并能够开始使用它来对比 SQL 语句在 MySQL 和 TiDB 中的行为差异。更多高级功能和详细配置，请参考项目官方文档。