README-zh.md

使用 SQLAlchemy 连接 TiDB

English | 中文

这是 PingCAP 为 SQLAlchemy 编写的用于连接 TIDB 的示例项目

TiDB 是一个兼容 MySQL 的数据库。SQLAlchemy 是 Python 实现的 SQL 工具包和 ORM（对象关系映射）。

前置要求

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

开始实践

1. 克隆示例代码仓库到本地

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

2. 安装依赖 (包括 SQLAlchemy 和 PyMySQL)

pip install -r requirements.txt

为什么我们需要安装 PyMySQL？

SQLAlchemy 是一个 ORM 库，支持多种数据库。它是数据库的高级抽象，可以帮助我们以更面向对象的方式编写 SQL 语句。但是，它并没有提供数据库驱动。我们需要安装数据库驱动来连接数据库。在这个示例项目中，我们使用 PyMySQL 作为数据库驱动，它是一个纯 Python 的 MySQL 客户端库，兼容 MySQL 和 TiDB，可以在所有平台上轻松安装。

你也可以使用其他数据库驱动，比如 mysqlclient 和 mysql-connector-python，但它们不是纯 Python 库，所以你需要安装相应的 C/C++ 编译器和 MySQL 客户端库来编译它们。更多信息，请参考 SQLAlchemy 官方文档。

3. 配置连接信息

(选项 1) TiDB Serverless

1. 在 TiDB Cloud 控制台中，打开 Clusters 页面，选择你的 TiDB Serverless 集群，进入 Overview 页面，点击右上角的 Connect 按钮。

2. 确认窗口中的配置和你的运行环境一致。

   • Endpoint Type 为 Public
   • Connect With 为 General
   • Operating System 为你的运行环境

   如果你在 Windows Subsystem for Linux (WSL) 中运行，请切换为对应的 Linux 发行版。

3. 点击 Generate password 生成密码。

   如果你之前已经生成过密码，可以直接使用原密码，或点击 Reset Password 重新生成密码。

4. 运行以下命令，将 .env.example 复制并重命名为 .env：

   cp .env.example .env

5. 复制并粘贴对应连接字符串至 .env 中。示例结果如下：

    TIDB_HOST='{gateway-region}.aws.tidbcloud.com'
    TIDB_PORT='4000'
    TIDB_USER='{prefix}.root'
    TIDB_PASSWORD='{password}'
    TIDB_DB_NAME='test'
    CA_PATH='{ca_path}'

   注意替换 {} 中的占位符为 Connect 窗口中获得的值。

   TiDB Serverless 要求使用安全连接，你可以参考 TiDB Cloud 文档获取不同操作系统下证书的路径。

6. 保存文件。

(选项 2) TiDB Dedicated

1. 在 TiDB Cloud Web Console 中，选择你的 TiDB Dedicated 集群，进入 Overview 页面，点击右上角的 Connect 按钮。点击 Allow Access from Anywhere 并点击 Download TiDB cluster CA 下载证书。

   更多配置细节，可参考 TiDB Dedicated 标准连接教程.

2. 运行以下命令，将 .env.example 复制并重命名为 .env：

   cp .env.example .env

3. 复制并粘贴对应的连接字符串至 .env 中。示例结果如下：

    TIDB_HOST='{host}.clusters.tidb-cloud.com'
    TIDB_PORT='4000'
    TIDB_USER='{username}'
    TIDB_PASSWORD='{password}'
    TIDB_DB_NAME='test'
    CA_PATH='{your-downloaded-ca-path}'

   注意替换 {} 中的占位符为 Connect 窗口中获得的值，并配置前面步骤中下载好的证书路径。

4. 保存文件。

(选项 3) 自建 TiDB

1. 运行以下命令，将 .env.example 复制并重命名为 .env：

   cp .env.example .env

2. 复制并粘贴对应 TiDB 的连接字符串至 .env 中。示例结果如下：

   TIDB_HOST='{tidb_server_host}'
   TIDB_PORT='4000'
   TIDB_USER='root'
   TIDB_PASSWORD='{password}'
   TIDB_DB_NAME='test'

   注意替换 {} 中的占位符为你的 TiDB 对应的值，并删除 CA_PATH 这行。如果你在本机运行 TiDB，默认 Host 地址为 127.0.0.1，密码为空。

3. 保存文件。

4. 运行示例代码

python sqlalchemy_example.py

5. 期望输出

期望的输出

下一步

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