数据库操作必读：SQLAlchemy入门

全文约 7991 字，读完可能需要 12 分钟。

环境 ：Ubuntu 15.10 64-bit

SQLAlchemy是Python的ORM框架，它的理念是：数据库的量级和性能重要于对象集合，而对象集合的抽象又重要于表和行。

安装

直接通过pip安装：

$ pip install sqlalchemy

打开Python，测试是否安装成功：

>>> import sqlalchemy>>> sqlalchemy.__version__'1.0.9'

创建引擎

SQLite

首先以SQLite为例，因为它比较简单。

from sqlalchemy import create_engine, MetaDataengine = create_engine('sqlite:///foo.db', echo=True)metadata = MetaData(engine)

参数 sqlite:///foo.db 解释为：

sqlite://<nohostname>/<path>

其中foo.db是相对路径。也可写成：

sqlite:///./foo.db

SQLAlchemy缺省使用Python内建的sqlite3模块来连接或创建SQLite数据库。执行完create_engine后，可以发现当前目录多了foo.db文件，不妨用sqlite打开看看。

$ sqlite3 foo.dbSQLite version 3.8.11.1 2015-07-29 20:00:57Enter ".help" for usage hints.sqlite> .tables

注意这里用的是sqlite3而非sqlite，因为foo.db是经由Python内建的sqlite3模块创建的。

MySQL

再来看看连接MySQL时怎么创建引擎。 本文后续示例全部基于MySQL，这是与官方文档不同的地方。 先在MySQL里创建一个测试数据库：sa_test，后续示例都将基于这个数据库。

mysql> CREATE DATABASE sa_test DEFAULT CHARACTER SET UTF8;

from sqlalchemy import create_engine, MetaDataengine = create_engine('mysql+mysqldb://root:******@localhost/sa_test', echo=True)metadata = MetaData(engine)

这里的参数看上去就比较复杂了，完整的格式为：

dialect+driver://username:password@host:port/database

这里driver用了mysqldb，详见： MySQLdb：Python操作MySQL数据库

引擎配置的详细信息可参考官方文档： Engine Configuration

MetaData

前面在创建MetaData时绑定了引擎：

metadata = MetaData(engine)

当然也可以不绑定。绑定的好处是，后续很多调用 （比如 MetaData.create_all()，Table.create()，等等）就不用指定引擎了。

创建表

创建两张表，user和address，address表里有一个user id的外键。 注意：表名没有像官方文档及很多人推荐的那样使用复数形式，个人偏好而已，详细讨论请见StackOverflow的这个问题： Table NamingDilemma: Singular vs. Plural Names

from sqlalchemy import create_engine, MetaData,        Table, Column, Integer, String, ForeignKeyengine = create_engine('mysql+mysqldb://root:******@localhost/sa_test', echo=True)metadata = MetaData(engine)

user_table = Table('user', metadata,        Column('id', Integer, primary_key=True),        Column('name', String(50)),        Column('fullname', String(100))        )address_table = Table('address', metadata,        Column('id', Integer, primary_key=True),        Column('user_id', None, ForeignKey('user.id')),        Column('email', String(128), nullable=False)        )metadata.create_all()

执行完metadata.create_all()这一句，两张表就创建好了，可以在MySQL里立即查看。

MetaData.create all()可以多次调用，不会报错，它在内部会检查表是否已经创建。 因为MetaData创建时已经绑定了引擎，所以此处create all()就不必再指定了，否则得写成：

metadata.create_all(engine)

创建引擎时，echo参数为True，程序运行时便有很多调试信息打印出来。在这些调试信息中，可以看到如下两条MySQL的CREATE TABLE语句：

CREATE TABLE user (    id INTEGER NOT NULL AUTO_INCREMENT,    name VARCHAR(50),    fullname VARCHAR(100),    PRIMARY KEY (id))CREATE TABLE address (    id INTEGER NOT NULL AUTO_INCREMENT,    user_id INTEGER,    email VARCHAR(128) NOT NULL,    PRIMARY KEY (id),    FOREIGN KEY(user_id) REFERENCES user (id))

除了metadata.create_all()，Table自己也有create方法：

create(bind=None, checkfirst=False)

参数bind一般就是指引擎。 参数checkfirst表示是否检查表已经存在。为True时，若表已经存在，不报错，只是什么也不做；为False时，若表已经存在，则将引发异常。 使用这个方法来创建这两张表：

user_table.create(checkfirst=True)address_table.create(checkfirst=True)

这里忽略了bind参数，因为创建MetaData对象时已经绑定了引擎，而创建表对象时又传入了metadata，所以顺藤摸瓜，表自己是知道引擎的。 如果调整一下表的创建顺序，就会报错，因为address表里有一个user表的外键，而这时候user表还没创建呢。所以，还是建议使用MetaData.create_all()吧，毕竟它也会检查表是否已经存在。

表的反射 Table Reflection

表创建好了，一般也就不动了。所以实际应用时，往往表都已经存在，并不需要创建，只需把它们"导入"进来即可，这时就得使用autoload参数。

from sqlalchemy import create_engine, MetaData, Tableengine = create_engine('mysql+mysqldb://root:******@localhost/sa_test', echo=False)metadata = MetaData(engine)user_table = Table('user', metadata, autoload=True)print 'user' in metadata.tablesprint [c.name for c in user_table.columns]address_table = Table('address', metadata, autoload=True)print 'address' in metadata.tables

输出：

True['id', 'name', 'fullname']True

如果MetaData没有绑定引擎，则另需指定autoload_with参数：

user_table = Table('user', metadata, autoload=True, autoload_with=engine)

如果被反射的表外键引用了另一个表，那么被引用的表也会一并被反射。比如只反射address表，user表也一并被反射了。

from sqlalchemy import create_engine, MetaData, Tableengine = create_engine('mysql+mysqldb://root:******@localhost/sa_test', echo=False)metadata = MetaData(engine)address_table = Table('address', metadata, autoload=True)print 'user' in metadata.tablesprint 'address' in metadata.tables

输出：

TrueTrue

插入数据

插入数据之前，必须要有表对象，不管是新创建的，还是通过反射导入的。

Insert对象

要往表里插数据，先创建一个Insert对象：

ins = user_table.insert()print ins

打印这个Insert对象，可以看到它所对应的SQL语句：

INSERT INTO user (id, name, fullname) VALUES (%s, %s, %s)

如果连接的数据库不是MySQL而是SQLite，那输出可能就是下面这样：

INSERT INTO user (id, name, fullname) VALUES (?, ?, ?)

可见SQLAlchemy帮我们封装了不同数据库之间语法的差异。 如果MetaData创建时没有绑定引擎，那么输出会略有不同：

INSERT INTO "user" (id, name, fullname) VALUES (:id, :name, :fullname)

这时SQLAlchemy还不知道具体的数据库语法，表名加了引号（"user"），列名也改用为:id之类一般性的格式。 此外，这条INSERT语句列出了user表里的每一列，而id在插入时一般是不需要指定的，可以通过Insert.values()方法加以限制：

ins = ins.values(name='adam', fullname='Adam Gu')print ins

限制后，id列已经没有了：

INSERT INTO user (name, fullname) VALUES (%s, %s)

可见values()方法限制了INSERT语句所包含的列。但是我们指定的name和fullname的值并没有打印出来，这两个值保存在Insert对象里，只有等到执行时才会用到。

执行

我们一直在说的引擎，可以理解成一个数据库连接对象的仓库，通过连接对象可以往数据库发送具体的SQL语句。调用引擎的connect()方法可以获取一个连接：

conn = engine.connect()

现在把前面的Insert对象丢给它来执行：

result = conn.execute(ins)

由调试信息可见具体的INSERT语句：

INSERT INTO user (name, fullname) VALUES (%s, %s)('adam', 'Adam Gu')COMMIT

返回值result是一个ResultProxy对象，ResultProxy是对DB- API中cursor的封装。插入语句的结果并不常用，但是查询语句肯定是要用到它的。 不妨在MySQL里看一下刚插入的数据。

mysql> select * from user;+----+------+----------+| id | name | fullname |+----+------+----------+|  1 | adam | Adam Gu  |+----+------+----------+1 row in set (0.00 sec)

执行多条语句

还记得前面的Insert对象使用values()方法来限制列吗？

ins = ins.values(name='adam', fullname='Adam Gu')

这种方式其实不利于Insert对象的复用，更好的做法是把参数通过execute()方法传进去：

ins = user_table.insert()conn.execute(ins, name='adam', fullname='Adam Gu')

Insert对象本身还是会包含所有列，最终INSERT语句里的列由execute()的参数决定。由调试信息可见具体的INSERT语句：

INSERT INTO user (name, fullname) VALUES (%s, %s)('adam', 'Adam Gu')COMMIT

一次插入多条记录也很简单，只要传一个字典列表（每个字典的键必须一致）给execute()即可。

conn.execute(address_table.insert(), [    { 'user_id': 1, 'email': 'sprinfall@gmail.com' },    { 'user_id': 1, 'email': 'sprinfall@hotmail.com' },    ])

调试信息里具体的INSERT语句：

INSERT INTO address (user_id, email) VALUES (%s, %s)((1, 'sprinfall@gmail.com'), (1, 'sprinfall@hotmail.com'))COMMIT

在MySQL里看一下插入的地址：

mysql> select * from address;+----+---------+-----------------------+| id | user_id | email                 |+----+---------+-----------------------+|  1 |       1 | sprinfall@gmail.com   ||  2 |       1 | sprinfall@hotmail.com |+----+---------+-----------------------+2 rows in set (0.00 sec)