如何用 go-sql-driver/mysql 连接到 TiDB
August 25, 2023 · View on GitHub
English | 中文
这是 PingCAP 为 go-sql-driver/mysql 编写的用于连接 TiDB 的示例项目
TiDB 是一个兼容 MySQL 的数据库。go-sql-driver/mysql 是 database/sql 接口的 MySQL 实现。
前置要求
- 推荐 Golang 1.20 及以上版本。
- Git。
- TiDB 集群。如果你还没有 TiDB 集群,可以按照以下方式创建:
- (推荐方式)参考创建 TiDB Serverless 集群,创建你自己的 TiDB Cloud 集群。
- 参考部署本地测试 TiDB 集群或部署正式 TiDB 集群,创建本地集群。
开始实践
1. 克隆示例代码仓库到本地
git clone https://github.com/tidb-samples/tidb-golang-sql-driver-quickstart.git
cd tidb-golang-sql-driver-quickstart
2. 配置连接信息
(选项 1) TiDB Serverless
-
在 TiDB Cloud 控制台中,打开 Clusters 页面,选择你的 TiDB Serverless 集群,进入 Overview 页面,点击右上角的 Connect 按钮。
-
确认窗口中的配置和你的运行环境一致。
- Endpoint Type 为 Public
- Connect With 为 General
- Operating System 为你的运行环境
如果你在 Windows Subsystem for Linux (WSL) 中运行,请切换为对应的 Linux 发行版。
-
点击 Generate password 生成密码。
如果你之前已经生成过密码,可以直接使用原密码,或点击 Reset Password 重新生成密码。
-
运行以下命令,将
.env.example复制并重命名为.env:cp .env.example .env -
复制并粘贴对应连接字符串至
.env中。TIDB_HOST='{gateway-region}.aws.tidbcloud.com' TIDB_PORT='4000' TIDB_USER='{prefix}.root' TIDB_PASSWORD='{password}' TIDB_DB_NAME='test' USE_SSL='true'注意替换
{}中的占位符为 Connect 窗口中获得的值。TiDB Serverless 要求使用 secure connection,因此
USE_SSL的值应为true。 -
保存文件。
(选项 2) TiDB Dedicated
-
在 TiDB Cloud Web Console 中,选择你的 TiDB Dedicated 集群,进入 Overview 页面,点击右上角的 Connect 按钮。点击 Allow Access from Anywhere。
更多配置细节,可参考 TiDB Dedicated 标准连接教程.
-
运行以下命令,将
.env.example复制并重命名为.env:cp .env.example .env -
复制并粘贴对应的连接字符串至
.env中。需更改部分示例结果如下。TIDB_HOST='{host}.clusters.tidb-cloud.com' TIDB_PORT='4000' TIDB_USER='{prefix}.root' TIDB_PASSWORD='{password}' TIDB_DB_NAME='test' USE_SSL='false'注意替换
{}中的占位符为 Connect 窗口中获得的值,并配置前面步骤中下载好的证书路径。 -
保存文件。
(选项 3) 自建 TiDB
-
运行以下命令,将
.env.example复制并重命名为.env:cp .env.example .env -
复制并粘贴对应的连接字符串至
.env中。需更改部分示例结果如下。TIDB_HOST='{tidb_server_host}' TIDB_PORT='4000' TIDB_USER='root' TIDB_PASSWORD='{password}' TIDB_DB_NAME='test' USE_SSL='false'注意替换
{}中的占位符为你的 TiDB 对应的值。如果你在本机运行 TiDB,默认 Host 地址为127.0.0.1,密码为空。 -
保存文件。
3. 运行示例代码
make
4. 期望输出
注意事项
关于 go-sql-driver/mysql 的更多使用方法及细节,可以参考 go-sql-driver/mysql 官方文档。