使用 Go-MySQL-Driver 连接 TiDB

TiDB 是兼容 MySQL 的数据库，Go-MySQL-Driver 是 database/sql 接口的 MySQL 实现。

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

• 搭建你的开发环境。
• 使用 Go-MySQL-Driver 连接到你的 TiDB 集群。
• 构建并运行你的应用程序。你还可以参考 示例代码片段 完成基本的 CRUD 操作。

前置条件

完成本教程，你需要：

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

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

• （推荐）参考 创建 Starter 集群 创建属于你自己的 TiDB Cloud 集群。
• 参考 部署本地测试 TiDB 集群 或 部署生产环境 TiDB 集群 创建本地集群。

运行示例应用连接 TiDB

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

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

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

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

第 2 步：配置连接信息

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

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

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

   make
   

2. 检查 Expected-Output.txt 文件，确认输出是否一致。

示例代码片段

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

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

连接 TiDB

func openDB(driverName string, runnable func(db *sql.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 := sql.Open(driverName, dsn)
    if err != nil {
        panic(err)
    }
    defer db.Close()

    runnable(db)
}

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

插入数据

openDB("mysql", func(db *sql.DB) {
    insertSQL = "INSERT INTO player (id, coins, goods) VALUES (?, ?, ?)"
    _, err := db.Exec(insertSQL, "id", 1, 1)

    if err != nil {
        panic(err)
    }
})

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

查询数据

openDB("mysql", func(db *sql.DB) {
    selectSQL = "SELECT id, coins, goods FROM player WHERE id = ?"
    rows, err := db.Query(selectSQL, "id")
    if err != nil {
        panic(err)
    }

    // This line is extremely important!
    defer rows.Close()

    id, coins, goods := "", 0, 0
    if rows.Next() {
        err = rows.Scan(&id, &coins, &goods)
        if err == nil {
            fmt.Printf("player id: %s, coins: %d, goods: %d\n", id, coins, goods)
        }
    }
})

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

更新数据

openDB("mysql", func(db *sql.DB) {
    updateSQL = "UPDATE player set goods = goods + ?, coins = coins + ? WHERE id = ?"
    _, err := db.Exec(updateSQL, 1, -1, "id")

    if err != nil {
        panic(err)
    }
})

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

删除数据

openDB("mysql", func(db *sql.DB) {
    deleteSQL = "DELETE FROM player WHERE id=?"
    _, err := db.Exec(deleteSQL, "id")

    if err != nil {
        panic(err)
    }
})

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

实用说明

使用驱动还是 ORM 框架？

Golang 驱动提供了对数据库的底层访问，但这要求开发者：

• 手动建立和释放数据库连接。
• 手动管理数据库事务。
• 手动将数据行映射为数据对象。

除非你需要编写复杂的 SQL 语句，否则推荐使用 ORM 框架进行开发，例如 GORM。它可以帮助你：

• 减少管理连接和事务的 样板代码。
• 通过数据对象操作数据，而不是大量 SQL 语句。

后续步骤

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

需要帮助？

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