Python ORM 框架：SQLAlchemy 完全指南

2.数据操作

增加数据

# 单条插入 user = User(username='bob', email='[email protected]') session.add(user) session.commit() # 批量插入 users = [ User(username='user1', email='[email protected]'), User(username='user2', email='[email protected]') ] session.add_all(users) session.commit()

查询数据

# 基本查询 users = session.query(User).all() first_user = session.query(User).first() user_by_id = session.query(User).get(1) # 条件查询 active_users = session.query(User).filter(User.is_active == True).all() user_by_email = session.query(User).filter(User.email == '[email protected]').first() # 复杂查询 from sqlalchemy import and_, or_, not_ # AND 条件 users = session.query(User).filter( and_(User.is_active == True, User.username.like('%alice%')) ).all() # OR 条件 users = session.query(User).filter( or_(User.username.like('%alice%'), User.email.like('%example%')) ).all() # 排序和限制 recent_users = session.query(User).order_by(User.created_at.desc()).limit(10).all() # 分页查询 page = 1 per_page = 20 users = session.query(User).offset((page-1)*per_page).limit(per_page).all()

更新数据

# 更新单条记录 user = session.query(User).filter(User.id == 1).first() if user: user.email = '[email protected]' session.commit() # 批量更新 session.query(User).filter(User.is_active == False).update({ User.is_active: True }) session.commit()

删除数据

# 删除单条记录 user = session.query(User).filter(User.id == 1).first() if user: session.delete(user) session.commit() # 批量删除 session.query(User).filter(User.is_active == False).delete() session.commit()

五、事务管理

SQLAlchemy 提供了多种事务管理方式，主要包括事务的开启、提交和回滚等操作。

1.事务的开启

在 SQLAlchemy 中，事务通常在执行数据库操作时自动开启。当使用 ORM 进行数据库操作时，SQLAlchemy 会自动管理事务的生命周期。

2.事务的提交

事务提交是指将事务中的所有操作永久保存到数据库中。在 SQLAlchemy 中，可以通过 session.commit() 方法来提交当前事务。提交成功后，事务所做的所有更改将永久保存在数据库中。

3.事务的回滚

当事务执行过程中出现错误或者需要取消操作时，可以使用回滚功能。通过 session.rollback() 方法，可以撤销当前事务中的所有操作，使数据库恢复到事务开始前的状态。回滚是保证数据一致性的重要手段。

4.完整示例

from sqlalchemy import create_engine, Column, Integer, String from sqlalchemy.ext.declarative import declarative_base from sqlalchemy.orm import sessionmaker from datetime import datetime # 创建数据库连接 engine = create_engine('sqlite:///example.db', echo=True) Base = declarative_base() # 定义模型 class User(Base): __tablename__ = 'users' id = Column(Integer, primary_key=True, autoincrement=True) username = Column(String(50), unique=True, nullable=False) email = Column(String(100), unique=True, nullable=False) created_at = Column(DateTime, default=datetime.utcnow) # 创建表 Base.metadata.create_all(engine) # 创建会话工厂 Session = sessionmaker(bind=engine) # 创建会话 session = Session() try: # 开始事务 user = User(username='transaction_user', email='[email protected]') session.add(user) # 提交事务 session.commit() print("Transaction completed successfully") except Exception as e: # 回滚事务 session.rollback() print(f"Transaction failed: {e}") finally: session.close()

六、上下文管理器

SQLAlchemy 的上下文管理器提供了一种优雅的方式来管理数据库会话和事务，通过 with 语句实现，确保资源在使用后被正确清理和释放，即使在发生异常的情况下也是如此。在 SQLAlchemy 中，上下文管理器主要用于管理会话的生命周期和事务边界。

from contextlib import contextmanager from sqlalchemy import create_engine, Column, Integer, String from sqlalchemy.ext.declarative import declarative_base from sqlalchemy.orm import sessionmaker from datetime import datetime # 创建数据库连接 engine = create_engine('sqlite:///example.db', echo=True) Base = declarative_base() # 定义模型 class User(Base): __tablename__ = 'users' id = Column(Integer, primary_key=True, autoincrement=True) username = Column(String(50), unique=True, nullable=False) email = Column(String(100), unique=True, nullable=False) created_at = Column(DateTime, default=datetime.utcnow) # 创建表 Base.metadata.create_all(engine) # 创建会话工厂 Session = sessionmaker(bind=engine) # 创建会话 session = Session() @contextmanager def get_db_session(): session = Session() try: yield session session.commit() except Exception: session.rollback() raise finally: session.close() # 使用示例 with get_db_session() as session: user = User(username='context_user', email='[email protected]') session.add(user)

七、细节说明

1.连接池配置

SQLAlchemy 的连接池通过复用数据库连接大幅提升性能，减少创建和销毁连接的开销。它能智能管理资源、自动处理失效连接，保证应用稳定运行。

from sqlalchemy import create_engine engine = create_engine( 'mysql+pymysql://user:password@localhost/dbname', pool_size=10, # 连接池大小 max_overflow=20, # 最大溢出连接数 pool_timeout=30, # 连接超时时间 pool_recycle=3600 # 连接回收时间 )

2.自动建表

使用 SQLAlchemy 的 declarative_base 系统定义模型类时，Base.metadata.create_all(bind=engine) 方法会自动创建所有还未在数据库中创建的表。

但是，Base.metadata.create_all(engine) 必须在 class User(Base) 之后执行才能成功创建表。

这是因为：

• 元数据收集机制：SQLAlchemy 的 Base.metadata 是一个容器，它会自动收集所有继承自 Base 的模型类的表结构信息。
• 注册时机：只有当 Python 解释器执行完类定义语句后，这个类才会被注册到 Base.metadata 中。
• 内部机制：当定义 class DataRecord(Base) 时，SQLAlchemy 会在 Base.metadata 中注册这个表的定义。只有注册之后，create_all() 才知道要创建哪些表。

3.数据库操作方法

对于创建的会话 db = Session()，使用 db 可以做很多操作。

（1）对象状态管理操作

db.add(instance)：将一个对象实例添加到当前会话中，准备插入到数据库 db.delete(instance)：标记一个对象实例为删除状态，准备从数据库中删除

（2）会话控制操作

db.flush()：将当前会话中的所有挂起更改发送到数据库，但不提交事务 db.commit()：提交当前事务，将所有更改永久保存到数据库 db.rollback()：回滚当前事务，撤销所有未提交的更改 db.close()：关闭会话，清理资源

（3）查询操作

db.query(Model)：创建一个查询对象 db.execute(statement)：执行原生 SQL 语句

（4）其他会话方法

db.merge(instance)：将实例的状态合并到当前会话中，如果实例已在会话中则更新，否则添加 db.refresh(instance)：从数据库重新加载对象的状态

4.db.add() 和 db.commit() 的区别

（1）db.add() 用于将对象添加到当前会话中，使 SQLAlchemy 开始跟踪这个对象的状态变化。当调用 session.add() 时，对象会被放入会话的待处理队列中，但此时数据并不会立即写入数据库，而是保持在内存中等待后续操作。

（2）db.commit() 则是将当前会话中的所有变更（包括添加、修改、删除等操作）真正提交到数据库的过程。执行 commit() 时，SQLAlchemy 会生成相应的 SQL 语句并执行，将内存中的变更持久化到数据库中，同时结束当前事务。