使用 GORM 连接 TiDB

TiDB 是一个兼容 MySQL 的数据库，GORM 是 Golang 领域流行的开源 ORM 框架。GORM 适配了 TiDB 的特性，如 AUTO_RANDOM，并且默认支持 TiDB 作为数据库选项。

在本教程中，你可以学习如何使用 TiDB 和 GORM 完成以下任务：

搭建你的开发环境。
使用 GORM 连接到你的 TiDB 集群。
构建并运行你的应用程序。你还可以在示例代码片段中找到基本 CRUD 操作的示例代码。

Note

本教程适用于平凯云 Starter , 平凯云 Essential 以及 TiDB 自建集群。

前置条件

完成本教程，你需要：

Go 1.20 或更高版本。
Git。
一个 TiDB 集群。

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

（推荐）参照创建平凯云 Starter 集群创建你自己的平凯数据库云服务集群。
参照部署本地测试 TiDB 集群或部署生产环境 TiDB 集群创建本地集群。

运行示例应用连接 TiDB

本节演示如何运行示例应用代码并连接到 TiDB。

步骤 1：克隆示例应用仓库

在终端窗口中运行以下命令，克隆示例代码仓库：

git clone https://github.com/tidb-samples/tidb-golang-gorm-quickstart.git
cd tidb-golang-gorm-quickstart

步骤 2：配置连接信息

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

进入 Clusters 页面，点击目标集群名称进入集群概览页面。
点击右上角的 Connect，弹出连接对话框。
确保连接对话框中的配置与你的操作环境一致。
- Connection Type 设置为 Public
- Branch 设置为 main
- Connect With 设置为 General
- Operating System 与你的环境一致
Tip

如果你的程序运行在 Windows Subsystem for Linux (WSL) 中，请切换到对应的 Linux 发行版。
点击 Generate Password 生成随机密码。

Tip

如果你之前已经创建过密码，可以继续使用原密码，或点击 Reset Password 生成新密码。
运行以下命令，复制 .env.example 并重命名为 .env：
```
cp .env.example .env
```
将对应的连接字符串复制粘贴到 .env 文件中。示例结果如下：
```
TIDB_HOST='{host}'  # e.g. gateway01.ap-northeast-1.prod.aws.tidbcloud.com
TIDB_PORT='4000'
TIDB_USER='{user}'  # e.g. xxxxxx.root
TIDB_PASSWORD='{password}'
TIDB_DB_NAME='test'
USE_SSL='true'
```
请务必将 {} 占位符替换为连接对话框中获取的连接参数。

平凯云 Starter 需要安全连接，因此你需要将 USE_SSL 设置为 true。
保存 .env 文件。

运行以下命令，复制 .env.example 并重命名为 .env：
```
cp .env.example .env
```
将对应的连接字符串复制粘贴到 .env 文件中。示例结果如下：
```
TIDB_HOST='{host}'
TIDB_PORT='4000'
TIDB_USER='root'
TIDB_PASSWORD='{password}'
TIDB_DB_NAME='test'
USE_SSL='false'
```
请务必将 {} 占位符替换为实际的连接参数，并将 USE_SSL 设置为 false。如果你在本地运行 TiDB，默认主机地址为 127.0.0.1，密码为空。
保存 .env 文件。

步骤 3：运行代码并检查结果

执行以下命令运行示例代码：
```
make
```
查看 Expected-Output.txt 文件，确认输出是否一致。

示例代码片段

你可以参考以下示例代码片段，完成你自己的应用开发。

完整示例代码及运行方法请参考 tidb-samples/tidb-golang-gorm-quickstart 仓库。

连接 TiDB

func createDB() *gorm.DB {
    dsn := fmt.Sprintf("%s:%s@tcp(%s:%s)/%s?charset=utf8mb4&tls=%s",
        ${tidb_user}, ${tidb_password}, ${tidb_host}, ${tidb_port}, ${tidb_db_name}, ${use_ssl})

    db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{
        Logger: logger.Default.LogMode(logger.Info),
    })
    if err != nil {
        panic(err)
    }

    return db
}

使用该函数时，你需要将 ${tidb_host}、${tidb_port}、${tidb_user}、${tidb_password} 和 ${tidb_db_name} 替换为你 TiDB 集群的实际值。平凯云 Starter 需要安全连接，因此你需要将 ${use_ssl} 设置为 true。

插入数据

db.Create(&Player{ID: "id", Coins: 1, Goods: 1})

更多信息请参考插入数据。

查询数据

var queryPlayer Player
db.Find(&queryPlayer, "id = ?", "id")

更多信息请参考查询数据。

更新数据

db.Save(&Player{ID: "id", Coins: 100, Goods: 1})

更多信息请参考更新数据。

删除数据

db.Delete(&Player{ID: "id"})

更多信息请参考删除数据。

后续步骤

通过 GORM 官方文档以及 GORM 文档中的 TiDB 章节学习更多 GORM 的用法。
通过开发者指南各章节，学习 TiDB 应用开发最佳实践，例如插入数据、更新数据、删除数据、单表读取、事务以及 SQL 性能优化。
通过专业的 TiDB 开发者课程，考试通过后获得 TiDB 认证。

需要帮助？

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