SQLAlchemy-TiDB 连接指南

1. 项目介绍

sqlalchemy-tidb 是一个专门为 SQLAlchemy 框架添加对 TiDB 数据库支持的项目。TiDB 是一款高度兼容 MySQL 的分布式数据库，而 SQLAlchemy 则是 Python 中流行的 SQL 工具包和对象关系映射（ORM）框架。通过这个项目，开发者可以在 Python 应用中使用 SQLAlchemy 无缝地连接和操作 TiDB 数据库。

支持版本

• TiDB: 4.x 及更高
• SQLAlchemy: 1.4.x 及更高
• Python: 3.6 及更高

2. 项目快速启动

要安装 sqlalchemy-tidb，可以使用 pip 安装最新的开发版本：

pip install git+https://github.com/pingcap/sqlalchemy-tidb.git@main

在你的 Python 应用中，你可以这样连接到数据库：

from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker

# TiDB 连接 URL 示例
URL = 'mysql+pymysql://username:password@localhost:4000/test'

# 创建数据库引擎
engine = create_engine(URL)

# 初始化 Session 类
Session = sessionmaker(bind=engine)

# 创建会话实例
session = Session()

# 执行 SQL 查询
result = session.execute('SELECT * FROM table_name')

# 处理查询结果
for row in result:
    print(row)

# 关闭会话
session.close()

3. 应用案例与最佳实践

使用 SQLAlchemy ORM

from sqlalchemy import Column, Integer, String, MetaData, Table
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()

class User(Base):
    __tablename__ = 'users'
    
    id = Column(Integer, primary_key=True)
    name = Column(String(50))
    email = Column(String(120))

# 创建表
Base.metadata.create_all(engine)

# 插入数据
new_user = User(id=1, name='John', email='[e-mail]')
session.add(new_user)
session.commit()

# 查询数据
users = session.query(User).all()
for user in users:
    print(user.name, user.email)

使用 SQLAlchemy Core

from sqlalchemy import create_engine, MetaData, Table

# 获取元数据对象
metadata = MetaData()

# 加载已有表
users = Table('users', metadata, autoload_with=engine)

# 执行 SQL 查询
query = users.select().where(users.c.email == '[e-mail]')
result = engine.execute(query)

# 处理查询结果
for row in result:
    print(row['name'])

4. 典型生态项目

• PyMySQL: 用于 Python 连接 MySQL 的库，也是 SQLAlchemy-TiDB 的底层实现之一。
• mysqlclient: 另一个常用的 Python MySQL 连接器，也与 SQLAlchemy 兼容。
• Django: 一个流行且强大的 Web 开发框架，支持 SQLAlchemy 作为 ORM 选项。
• Flask-SQLAlchemy: Flask 框架的一个扩展，提供了 SQLAlchemy 集成。

更多有关如何将 TiDB 集成到现有生态系统中的示例和最佳实践，可以在官方文档或社区论坛中找到。

---

本文档简要介绍了如何使用 SQLAlchemy-TiDB 连接和操作 TiDB 数据库，以及提供了一些基本的 ORM 和 Core API 示例。对于更深入的使用，建议查阅 SQLAlchemy 和 TiDB 的官方文档以获取更多信息。