使用 MySQL Workbench 连接到 TiDB

TiDB 是一个兼容 MySQL 的数据库。MySQL Workbench 是为 MySQL 数据库用户提供的 GUI 工具集。

警告

尽管由于 MySQL Workbench 兼容 MySQL，你可以使用 MySQL Workbench 连接到 TiDB，但 MySQL Workbench 并不完全支持 TiDB。由于 MySQL Workbench 将 TiDB 视为 MySQL，因此在使用过程中可能会遇到一些问题。

建议使用其它 TiDB 完全支持的 GUI 工具进行连接，例如 DataGrip，DBeaver 以及 VS Code SQLTools。TiDB 完全支持的 GUI 工具的完整列表，参考 TiDB 支持的第三方工具。

在本文档中，你可以学习如何使用 MySQL Workbench 连接到 TiDB。

注意

本文档适用于 TiDB Cloud Starter、TiDB Cloud Essential、TiDB Cloud Premium、TiDB Cloud Dedicated 和本地部署的 TiDB。

前置需求

为了能够顺利完成本文中的操作，你需要：

MySQL Workbench 8.0.31 或以上版本。
准备一个 TiDB 集群。

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

（推荐方式）创建 TiDB Cloud Starter 实例。
部署本地测试 TiDB Self-Managed 集群或部署正式 TiDB Self-Managed 集群。

连接到 TiDB

根据不同的 TiDB 部署方式，使用不同的方法连接到 TiDB。

在 TiDB Cloud 的 My TiDB 页面中，点击你目标 TiDB Cloud Starter 或 Essential 实例的名字，进入实例的 Overview 页面。
点击右上角的 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，输入第 4 步中生成的密码，然后点击 OK 保存密码。
下图显示了连接参数的示例：
点击 Test Connection 以验证与你目标 TiDB Cloud Starter 或 Essential 实例的连接。
如果连接测试成功，你可以看到 Successfully made the MySQL connection 信息。点击 OK 保存连接配置。

在 My TiDB 页面中，点击你目标 TiDB Cloud Premium 实例的名字，进入实例的 Overview 页面。
在左侧导航栏中，点击 Settings > Networking。
在 Networking 页面，点击 Public Endpoint 的 Enable，然后点击 Add IP Address。

确保你的客户端 IP 地址已添加到访问列表中。
在左侧导航栏中，点击 Overview 返回实例概览页面。
点击右上角的 Connect 按钮，将会弹出连接对话框。
在连接对话框中，从 Connection Type 下拉列表中选择 Public。
- 如果提示 Public Endpoint 正在开启，请等待该过程完成。
- 如果你尚未设置密码，请在对话框中点击 Set Root Password。
- 如果需要验证服务器证书或连接失败且需要 CA 证书，请点击 CA cert 下载证书。
- 除 Public 连接类型外，TiDB Cloud Premium 还支持 Private Endpoint 连接。详情请参阅通过 AWS PrivateLink 连接到 TiDB Cloud Premium。
启动 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 Premium 实例的密码，然后点击 OK 保存密码。
点击 Test Connection 以验证与 TiDB Cloud Premium 实例的连接。
如果连接测试成功，你可以看到 Successfully made the MySQL connection 信息。点击 OK 保存连接配置。

在 TiDB Cloud 的 My TiDB 页面中，点击你目标 TiDB Cloud Dedicated 集群的名字，进入集群的 Overview 页面。
点击右上角的 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 保存连接配置。

常见问题

如何处理连接超时错误 "Error Code: 2013. Lost connection to MySQL server during query"？

这个错误表示查询执行时间超过了超时限制。要解决这个问题，可以按照以下步骤调整超时设置：

启动 MySQL Workbench 并打开 Workbench Preferences 页面。
在 SQL Editor > MySQL Session 部分，调整 DBMS connection read timeout interval (in seconds) 的设置。该字段控制了 MySQL Workbench 在断开与服务器的连接之前查询可以执行的最长时间（以秒为单位）。

更多信息，可以参考 MySQL Workbench 常见问题。

下一步

关于 MySQL Workbench 的更多使用方法，可以参考 MySQL Workbench 官方文档。
你可以继续阅读开发者文档，以获取更多关于 TiDB 应用开发的最佳实践。例如：插入数据、更新数据、删除数据、单表读取、事务、SQL 性能优化等。
如果你更倾向于参与课程进行学习，我们也提供专业的 TiDB 开发者课程支持，并在考试后提供相应的资格认证。

需要帮助?

如果在开发的过程中遇到问题，可以在 AskTUG 论坛上提问，或从 PingCAP 官方或 TiDB 社区获取支持。