首页
/ SQLAlchemy-TiDB 连接指南

SQLAlchemy-TiDB 连接指南

2024-08-07 15:11:26作者:舒璇辛Bertina

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='john@example.com')
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 == 'john@example.com')
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 的官方文档以获取更多信息。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.93 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
553
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
423
392
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
511