使用 GORM 连接到 TiDB

TiDB 是一个兼容 MySQL 的数据库。GORM 是当前比较流行的开源 Golang ORM 框架并且适配了 TiDB 的 AUTO_RANDOM 等特性。同时，TiDB 为 GORM 的默认支持数据库。

本文档将展示如何使用 TiDB 和 GORM 来完成以下任务：

• 配置你的环境。
• 使用 GORM 连接到 TiDB 集群。
• 构建并运行你的应用程序。你也可以参考示例代码片段，完成基本的 CRUD 操作。

前置需求

• 推荐 Go 1.20 及以上版本。
• Git。
• TiDB 集群。如果你还没有 TiDB 集群，可以按照以下方式创建：
  • （推荐方式）参考创建 TiDB Serverless 集群，创建你自己的 TiDB Cloud 集群。
  • 参考部署本地测试 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 集群。

• TiDB Serverless
• TiDB Dedicated
• 本地部署 TiDB

第 3 步：运行代码并查看结果

1. 运行下述命令，执行示例代码：

   make
   

2. 查看 Expected-Output.txt，并与你的程序输出进行比较。结果近似即为连接成功。

示例代码片段

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

完整代码及其运行方式，见代码仓库 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 集群的实际值。因为 TiDB Serverless 要求使用 TLS (SSL) connection，因此在连接到 TiDB Serverless 时 ${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 官方文档 及 GORM 官方文档中的 TiDB 章节。
• 你可以继续阅读开发者文档，以获取更多关于 TiDB 应用开发的最佳实践。例如：插入数据、更新数据、删除数据、单表读取、事务、SQL 性能优化等。
• 如果你更倾向于参与课程进行学习，我们也提供专业的 TiDB 开发者课程支持，并在考试后提供相应的资格认证。

需要帮助?

如果在开发的过程中遇到问题，可以在 AskTUG 上进行提问，寻求帮助。