使用 mysqlclient 连接到 TiDB

TiDB 是一个兼容 MySQL 的数据库。mysqlclient 为当前流行的开源 Python Driver 之一。

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

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

前置需求

• 推荐 Python 3.8 及以上版本。
• Git。
• TiDB 集群。如果你还没有 TiDB 集群，可以按照以下方式创建：
  • （推荐方式）参考创建 TiDB Serverless 集群，创建你自己的 TiDB Cloud 集群。
  • 参考部署本地测试 TiDB 集群或部署正式 TiDB 集群，创建本地集群。

运行代码并连接到 TiDB

本小节演示如何运行示例应用程序的代码，并连接到 TiDB。

第 1 步：克隆示例代码仓库到本地

运行以下命令，将示例代码仓库克隆到本地：

git clone https://github.com/tidb-samples/tidb-python-mysqlclient-quickstart.git
cd tidb-python-mysqlclient-quickstart

第 2 步：安装依赖

运行以下命令，安装示例代码所需要的依赖（包括 mysqlclient）：

pip install -r requirements.txt

如果遇到安装问题，请参考 mysqlclient 官方文档。

第 3 步：配置连接信息

根据不同的 TiDB 部署方式，使用不同的方法连接到 TiDB 集群。

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

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

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

   python mysqlclient_example.py
   

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

示例代码片段

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

完整代码及其运行方式，见代码仓库 tidb-samples/tidb-python-mysqlclient-quickstart。

连接到 TiDB

def get_mysqlclient_connection(autocommit:bool=True) -> MySQLdb.Connection:
    db_conf = {
        "host": '${tidb_host}',
        "port": '${tidb_port}',
        "user": '${tidb_user}',
        "password": '${tidb_password}',
        "database": '${tidb_db_name}',
        "autocommit": autocommit
    }

    if '${ca_path}':
        db_conf["ssl_mode"] = "VERIFY_IDENTITY"
        db_conf["ssl"] = {"ca": '${ca_path}'}

    return MySQLdb.connect(**db_conf)

在使用该函数时，你需要将 ${tidb_host}、${tidb_port}、${tidb_user}、${tidb_password}、${tidb_db_name}、${ca_path} 等替换为你的 TiDB 集群的实际值。

插入数据

with get_mysqlclient_connection(autocommit=True) as conn:
    with conn.cursor() as cur:
        player = ("test", 1, 1)
        cursor.execute("INSERT INTO players (id, coins, goods) VALUES (%s, %s, %s)", player)

更多信息参考插入数据。

查询数据

with get_mysqlclient_connection(autocommit=True) as conn:
    with conn.cursor() as cur:
        cur.execute("SELECT count(*) FROM players")
        print(cur.fetchone()[0])

更多信息参考查询数据。

更新数据

with get_mysqlclient_connection(autocommit=True) as conn:
    with conn.cursor() as cur:
        player_id, amount, price="test", 10, 500
        cur.execute(
            "UPDATE players SET goods = goods + %s, coins = coins + %s WHERE id = %s",
            (-amount, price, player_id),
        )

更多信息参考更新数据。

删除数据

with get_mysqlclient_connection(autocommit=True) as conn:
    with conn.cursor() as cur:
        player_id = "test"
        cur.execute("DELETE FROM players WHERE id = %s", (player_id,))

更多信息参考删除数据。

注意事项

使用驱动程序还是 ORM 框架？

Python 驱动程序提供对数据库的底层访问，但要求开发者：

• 手动建立和释放数据库连接
• 手动管理数据库事务
• 手动将数据行（在 mysqlclient 中表示为元组 (tuple)）映射为数据对象

建议仅在需要编写复杂的 SQL 语句时使用驱动程序。其他情况下，建议使用 ORM 框架进行开发，例如 SQLAlchemy、Peewee 和 Django。ORM 可以帮助你：

• 减少管理连接和事务的模板代码
• 使用数据对象代替大量 SQL 语句来操作数据

下一步

• 关于 mysqlclient 的更多使用方法，可以参考 mysqlclient 官方文档。
• 你可以继续阅读开发者文档，以获取更多关于 TiDB 应用开发的最佳实践。例如：插入数据、更新数据、删除数据、单表读取、事务、SQL 性能优化等。
• 如果你更倾向于参与课程进行学习，我们也提供专业的 TiDB 开发者课程支持，并在考试后提供相应的资格认证。

需要帮助?

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