使用 MySQL Workbench 连接 TiDB

TiDB 是兼容 MySQL 的数据库，MySQL Workbench 是为 MySQL 数据库用户提供的图形化工具集。

警告

虽然你可以因为 TiDB 的 MySQL 兼容性而使用 MySQL Workbench 连接 TiDB，但 MySQL Workbench 并不完全支持 TiDB。在使用过程中可能会遇到一些问题，因为它会将 TiDB 视为 MySQL。
推荐使用官方支持 TiDB 的其他 GUI 工具，例如 DataGrip、DBeaver 和 VS Code SQLTools。完整支持 TiDB 的 GUI 工具列表请参见 TiDB 支持的第三方工具。

本教程将指导你如何使用 MySQL Workbench 连接到你的 TiDB 集群。

注意

本教程兼容 TiDB Cloud Starter, TiDB Cloud Essential, TiDB Cloud Dedicated 以及 TiDB 自建集群。

前提条件

完成本教程，你需要：

如果你还没有 TiDB 集群，可以按如下方式创建：

根据你选择的 TiDB 部署方式，连接到你的 TiDB 集群。

进入 Clusters 页面，点击目标集群名称进入其概览页面。
点击右上角的 Connect，弹出连接对话框。
确认连接对话框中的配置与你的操作环境一致。
- Connection Type 设置为 Public。
- Branch 设置为 main。
- Connect With 设置为 MySQL Workbench。
- Operating System 与你的环境一致。
点击 Generate Password 生成一个随机密码。
小贴士
如果你之前已经创建过密码，可以继续使用原密码，或者点击 Reset Password 生成新密码。
启动 MySQL Workbench，点击 MySQL Connections 标题旁的 +。
在 Setup New Connection 对话框中，配置以下连接参数：
- Connection Name：为该连接起一个有意义的名称。
- Hostname：输入 TiDB Cloud 连接对话框中的 HOST 参数。
- Port：输入 TiDB Cloud 连接对话框中的 PORT 参数。
- Username：输入 TiDB Cloud 连接对话框中的 USERNAME 参数。
- Password：点击 Store in Keychain ... 或 Store in Vault，输入 TiDB Cloud Starter 集群的密码，然后点击 OK 存储密码。
下图展示了连接参数的示例：
点击 Test Connection 验证与 TiDB Cloud Starter 集群的连接。
如果连接测试成功，你会看到 Successfully made the MySQL connection 消息。点击 OK 保存连接配置。

进入 Clusters 页面，点击目标集群名称进入其概览页面。
点击右上角的 Connect，弹出连接对话框。
在连接对话框中，从 Connection Type 下拉列表选择 Public，然后点击 CA cert 下载 CA 证书。
如果你还未配置 IP 访问列表，点击 Configure IP Access List 或按照配置 IP 访问列表的步骤进行配置后再首次连接。
除了 Public 连接类型，TiDB Cloud Dedicated 还支持 Private Endpoint 和 VPC Peering 连接类型。更多信息请参见连接到你的 TiDB Cloud Dedicated 集群。
启动 MySQL Workbench，点击 MySQL Connections 标题旁的 +。
在 Setup New Connection 对话框中，配置以下连接参数：
- Connection Name：为该连接起一个有意义的名称。
- Hostname：输入 TiDB Cloud 连接对话框中的 HOST 参数。
- Port：输入 TiDB Cloud 连接对话框中的 PORT 参数。
- Username：输入 TiDB Cloud 连接对话框中的 USERNAME 参数。
- Password：点击 Store in Keychain ...，输入 TiDB Cloud Dedicated 集群的密码，然后点击 OK 存储密码。
下图展示了连接参数的示例：
点击 Test Connection 验证与 TiDB Cloud Dedicated 集群的连接。
如果连接测试成功，你会看到 Successfully made the MySQL connection 消息。点击 OK 保存连接配置。

该错误表示查询执行时间超过了超时时间限制。你可以通过以下步骤调整超时设置来解决此问题：

启动 MySQL Workbench，进入 Workbench Preferences 页面。
在 SQL Editor > MySQL Session 部分，配置 DBMS connection read timeout interval (in seconds) 选项。该选项设置了查询最大允许执行时间（秒），超时后 MySQL Workbench 会断开与服务器的连接。

在 Discord 或 Slack 社区提问，或提交支持工单。