SQLAlchemy

SQLAlchemy

原作者	迈克尔·拜尔（Michael Bayer）
首次发布	2006年2月
当前版本	1.3.20（2020年10月12日​（2020-10-12））
源代码库	github.com/sqlalchemy/sqlalchemy
编程语言	Python
操作系统	跨平台
类型	对象关系映射
许可协议	MIT许可证
网站	www.sqlalchemy.org

SQLAlchemy是Python编程语言下的一款开源软件。提供了SQL工具包及对象关系映射（ORM）工具，使用MIT许可证发行。

SQLAlchemy“采用简单的Python语言，为高效和高性能的数据库访问设计，实现了完整的企业级持久模型”。SQLAlchemy的理念是，SQL数据库的量级和性能重要于对象集合；而对象集合的抽象又重要于表和行。因此，SQLAlchmey采用了类似于Java里Hibernate的数据映射模型，而不是其他ORM框架采用的Active Record模型。不过，Elixir和declarative等可选插件可以让用户使用声明语法。

SQLAlchemy首次发行于2006年2月，并迅速地在Python社区中最广泛使用的ORM工具之一，不亚于Django的ORM框架。

示例

下述示例描述了电影同导演的多对一关系。示例中说明了从用户定义的Python类创建数据表的方法，双方关系实例的创建方法，以及最终查询数据的方法：包括延迟加载和预先加载两种自动生成的SQL查询。

结构定义

创建两个Python类以及DBMS中对应的数据表：

from sqlalchemy import *
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import relation, sessionmaker

Base = declarative_base()
 
class Movie(Base):
    __tablename__ = 'movies'
 
    id = Column(Integer, primary_key=True)
    title = Column(String(255), nullable=False)
    year = Column(Integer)
    directed_by = Column(Integer, ForeignKey('directors.id'))
 
    director = relation("Director", backref='movies', lazy=False)
 
    def __init__(self, title=None, year=None):
        self.title = title
        self.year = year
    def __repr__(self):
        return "Movie(%r, %r, %r)" % (self.title, self.year, self.director)
 
class Director(Base):
    __tablename__ = 'directors'
 
    id = Column(Integer, primary_key=True)
    name = Column(String(50), nullable=False, unique=True)
 
    def __init__(self, name=None):
        self.name = name
 
    def __repr__(self):
        return "Director(%r)" % (self.name)
 
engine = create_engine('dbms://user:pwd@host/dbname')
Base.metadata.create_all(engine)

插入数据

插入的电影和导演对象可以互相引用：

Session = sessionmaker(bind=engine)
session = Session()

m1 = Movie("Star Trek", 2009)
m1.director = Director("JJ Abrams")

d2 = Director("George Lucas")
d2.movies = [Movie("Star Wars", 1977), Movie("THX 1138", 1971)]

try:
    session.add(m1)
    session.add(d2)
    session.commit()
except:
    session.rollback()

查询

alldata = session.query(Movie).all()
for somedata in alldata:
    print somedata

SQLAlchemy将向DBMS（忽略差异）发起如下查询：

SELECT movies.id, movies.title, movies.year, movies.directed_by, directors.id, directors.name 
FROM movies LEFT OUTER JOIN directors ON directors.id = movies.directed_by

并输出：

Movie('Star Trek', 2009L, Director('JJ Abrams'))
Movie('Star Wars', 1977L, Director('George Lucas'))
Movie('THX 1138', 1971L, Director('George Lucas'))

假如设置lazy=True（默认值），SQLAlchemy将首先发起对电影列表的查询，并在必要时（延迟加载）逐一查询导演的名称：

SELECT movies.id, movies.title, movies.year, movies.directed_by 
FROM movies

SELECT directors.id, directors.name
FROM directors 
WHERE directors.id = %s

参考文献

注释

• Gift, Noah. Using SQLAlchemy. Developerworks. IBM. 12 Aug 2008 [8 Feb 2011]. （原始内容存档于2011-08-12）. 
• Rick Copeland, Essential SQLAlchemy （页面存档备份，存于互联网档案馆）, O'Reilly, 2008, ISBN 0-596-51614-2

参见

• Pylons
• TurboGears

外部链接

• SQLAlchemy主页 （页面存档备份，存于互联网档案馆）
• SourceForge.net上的SQLAlchemy