使用 JetBrains DataGrip 连接 TiDB
TiDB 是兼容 MySQL 的数据库,JetBrains DataGrip 是一款强大的数据库和 SQL 集成开发环境(IDE)。本教程将引导你使用 DataGrip 连接到你的 TiDB 集群。
注意
本教程适用于 平凯云 Starter , 平凯云 Essential 以及 TiDB 自建集群。
你可以通过以下两种方式使用 DataGrip:
- 作为 DataGrip IDE 独立工具。
- 作为 JetBrains IDE(如 IntelliJ、PhpStorm 和 PyCharm)中的 Database Tools and SQL 插件。
本教程主要以独立 DataGrip IDE 为例。通过 JetBrains IDE 中的 Database Tools and SQL 插件连接 TiDB 的步骤类似。你也可以参考本文档中的步骤,在任何 JetBrains IDE 中连接 TiDB。
前置条件
完成本教程,你需要:
- DataGrip 2023.2.1 或更高版本 或非社区版 JetBrains IDE。
- 一个 TiDB 集群。
如果你还没有 TiDB 集群,可以按如下方式创建:
- (推荐)参考 创建 平凯云 Starter 集群 创建属于你自己的平凯数据库云服务集群。
- 参考 部署本地测试 TiDB 集群 或 部署生产环境 TiDB 集群 创建本地集群。
连接 TiDB
根据你选择的 TiDB 部署方式,连接到你的 TiDB 集群。
-
进入 Clusters 页面,点击目标集群名称,进入集群概览页。
-
点击右上角的 Connect,弹出连接对话框。
-
确认连接对话框中的配置与你的操作环境一致。
- Connection Type 设置为
Public - Branch 设置为
main - Connect With 设置为
DataGrip - Operating System 与你的环境一致
- Connection Type 设置为
-
点击 Generate Password 生成随机密码。
提示:
如果你之前已创建过密码,可以继续使用原密码,或点击 Reset Password 生成新密码。
-
启动 DataGrip 并创建一个项目用于管理你的连接。

-
在新建的项目中,点击 Database Explorer 面板左上角的 +,选择 Data Source > Other > TiDB。

-
从平凯数据库云服务连接对话框中复制连接字符串,粘贴到 URL 字段,其余参数会自动填充。示例如下:

如果出现 Download missing driver files 警告,点击 Download 下载驱动文件。
-
点击 Test Connection 验证与 平凯云 Starter 集群的连接。

-
点击 OK 保存连接配置。
-
启动 DataGrip 并创建一个项目用于管理你的连接。

-
在新建的项目中,点击 Database Explorer 面板左上角的 +,选择 Data Source > Other > TiDB。

-
配置以下连接参数:
- Host:你的 TiDB 自建集群的 IP 地址或域名
- Port:你的 TiDB 自建集群的端口号
- User:用于连接 TiDB 自建集群的用户名
- Password:该用户名的密码
示例:

如果出现 Download missing driver files 警告,点击 Download 下载驱动文件。
-
点击 Test Connection 验证与 TiDB 自建集群的连接。

-
点击 OK 保存连接配置。
后续步骤
- 通过 DataGrip 官方文档 了解更多 DataGrip 的用法。
- 通过 开发者指南 各章节,学习 TiDB 应用开发最佳实践,例如 插入数据、更新数据、删除数据、单表读取、事务 以及 SQL 性能优化。
- 通过专业的 TiDB 开发者课程,并在通过考试后获得 TiDB 认证。