【Python】PythonSQLAlchemy基本操作和常⽤技巧
⾸先说下，由于最新的 0.8 版还是开发版本，因此我使⽤的是 0.79 版，API 也许会有些不同。
因为我是搭配 MySQL InnoDB 使⽤，所以使⽤其他数据库的也不能完全照搬本⽂。
接着就从安装开始介绍吧，以 Debian/Ubuntu 为例（请确保有管理员权限）：
1.MySQL
apt-get install mysql-server
apt-get install mysql-client
apt-get install libmysqlclient15-dev
2.python-mysqldb
apt-get install python-mysqldb
3.easy_install
wget lecommunity/dist/ez_setup.py
python ez_setup.py
4.MySQL-Python
easy_install MySQL-Python
5.SQLAlchemy
easy_install SQLAlchemy
如果是⽤其他操作系统，遇到问题就 Google ⼀下吧。我是在 Mac OS X 上开发的，途中也遇到些问题，不过当时没记下来……
值得⼀提的是我⽤了 MySQL-Python 来连 MySQL，因为不⽀持异步调⽤，所以和 Tornado 不是很搭。不过性能其实很好，因此以后再去研究下其他⽅案吧……
装好后就可以开始使⽤了：
from sqlalchemy import create_engine
import sessionmaker
DB_CONNECT_STRING = 'mysql+mysqldb://root:123@localhost/ooxx?charset=utf8'
engine = create_engine(DB_CONNECT_STRING, echo=True)
DB_Session = sessionmaker(bind=engine)
session = DB_Session()
这⾥的 DB_CONNECT_STRING 就是连接数据库的路径。“mysql+mysqldb”指定了使⽤ MySQL-Python 来连接，“root”和“123”分别是⽤户名和密码，“localhost”是数据库的域名，“ooxx”是使⽤的数据库名（可省略），“charset”指定了连接时使⽤的字符集（可省略）。
create_engine() 会返回⼀个数据库引擎，echo 参数为 True 时，会显⽰每条执⾏的 SQL 语句，⽣产环境下可关闭。
sessionmaker() 会⽣成⼀个数据库会话类。这个类的实例可以当成⼀个数据库连接，它同时还记录了⼀些查询的数据，并决定什么时候执⾏ SQL 语句。由于 SQLAlchemy ⾃⼰维护了⼀个数据库连接池（默认 5 个连接），因此初始化⼀个会话的开销并不⼤。对 Tornado ⽽⾔，可以在 BaseHandler 的 initialize() ⾥初始化：
class BaseHandler(tornado.web.RequestHandler):
def initialize(self):
self.session = models.DB_Session()
def on_finish(self):
self.session.close()
对其他 Web 服务器来说，可以使⽤ scoped_session，它能保证每个线程获得的 session 对象都是唯⼀的。不过 Tornado 本⾝就是单线程的，如果使⽤了异步⽅式，就可能会出现问题，因此我并没使⽤它。
拿到 session 后，就可以执⾏ SQL 了：
ute('create database abc')
2 ute('show databases').fetchall()
ute('use abc')
4 # 建 user 表的过程略
5 ute('select * from user where id = 1').first()
6 ute('select * from user where id = :id', {'id': 1}).first()
不过这和直接使⽤ MySQL-Python 没啥区别，所以就不介绍了；我还是喜欢 ORM 的⽅式，这也是我采⽤ SQLAlchemy 的唯⼀原因。
于是来定义⼀个表：
1from sqlalchemy import Column
pes import CHAR, Integer, String
declarative import declarative_base
4
5 BaseModel = declarative_base()
6 def init_db():
7 ate_all(engine)
8 def drop_db():
9 adata.drop_all(engine)
10
11class User(BaseModel):
12 __tablename__ = 'user'
13 id = Column(Integer, primary_key=True)
14 name = Column(CHAR(30)) # or Column(String(30))
15 init_db()
declarative_base() 创建了⼀个 BaseModel 类，这个类的⼦类可以⾃动与⼀个表关联。
以 User 类为例，它的 __tablename__ 属性就是数据库中该表的名称，它有 id 和 name 这两个字段，分别为整型和 30 个定长字符。Column 还有⼀些其他的参数，我就不解释了。
最后，ate_all(engine) 会到 BaseModel 的所有⼦类，并在数据库中建⽴这些表；drop_all() 则是删除这些表。
接着就开始使⽤这个表吧：
1from sqlalchemy import func, or_, not_
2
3 user = User(name='a')
4 session.add(user)
5 user = User(name='b')
6 session.add(user)
7 user = User(name='a')
8 session.add(user)
9 user = User()
10 session.add(user)
11 sessionmit()
12 query = session.query(User)
13 print query # 显⽰SQL 语句
14 print query.statement # 同上
15for user in query: # 遍历时查询
16 print user.name
17 print query.all() # 返回的是⼀个类似列表的对象
20 print query.filter(User.id == 2).first().name
21 (2).name # 以主键获取，等效于上句
22 print query.filter('id = 2').first().name # ⽀持字符串
23 query2 = session.query(User.name)
24 print query2.all() # 每⾏是个元组
25 print query2.limit(1).all() # 最多返回1条记录
26 print query2.offset(1).all() # 从第2条记录开始返回
27 der_by(User.name).all()
28 der_by('name').all()
29 der_by(User.name.desc()).all()
30 der_by('name desc').all()
31 print session.query(User.id).order_by(User.name.desc(), User.id).all()
32 print query2.filter(User.id == 1).scalar() # 如果有记录，返回第⼀条记录的第⼀个元素
33 print session.query('id').select_from(User).filter('id = 1').scalar()
34 print query2.filter(User.id > 1, User.name != 'a').scalar() # and
35 query3 = query2.filter(User.id > 1) # 多次拼接的 filter 也是 and
36 query3 = query3.filter(User.name != 'a')
37 print query3.scalar()
38 print query2.filter(or_(User.id == 1, User.id == 2)).all() # or
39 print query2.filter(User.id.in_((1, 2))).all() # in
40 query4 = session.query(User.id)
41 print query4.filter(User.name == None).scalar()
42 print query4.filter('name is null').scalar()
43 print query4.filter(not_(User.name == None)).all() # not
44 print query4.filter(User.name != None).all()
45 unt()
46 print session.unt('*')).select_from(User).scalar()
47 print session.unt('1')).select_from(User).scalar()
48 print session.unt(User.id)).scalar()
49 print session.unt('*')).filter(User.id > 0).scalar() # filter() 中包含 User，因此不需要指定表
50 print session.unt('*')).filter(User.name == 'a').limit(1).scalar() == 1 # 可以⽤ limit() 限制 count() 的返回数
51 print session.query(func.sum(User.id)).scalar()
52 print session.w()).scalar() # func 后可以跟任意函数名，只要该数据库⽀持
53 print session.query(func.current_timestamp()).scalar()
54 print session.query(func.md5(User.name)).filter(User.id == 1).scalar()
55 query.filter(User.id == 1).update({User.name: 'c'})
56 user = (1)
57 print user.name
58 user.name = 'd'
59 session.flush() # 写数据库，但并不提交
60 (1).name
61 session.delete(user)
62 session.flush()
63 (1)
llback()
65 (1).name
66 query.filter(User.id == 1).delete()
67 sessionmit()
68 (1)
增删改查都涉及到了，⾃⼰看看输出的 SQL 语句就知道了，于是基础知识就介绍到此了。
下⾯开始介绍⼀些进阶的知识。
如何批量插⼊⼤批数据？
可以使⽤⾮ ORM 的⽅式：
User.__table__.insert(),
[{'name': `randint(1, 100)`,'age': randint(1, 100)} for i in xrange(10000)]
)
sessionmit()
上⾯我批量插⼊了 10000 条记录，半秒内就执⾏完了；⽽ ORM ⽅式会花掉很长时间。
如何让执⾏的 SQL 语句增加前缀？
使⽤ query 对象的 prefix_with() ⽅法：
session.query(User.name).prefix_with('HIGH_PRIORITY').all()
如何替换⼀个已有主键的记录？
使⽤ () ⽅法替代 session.add()，其实就是 SELECT + UPDATE：
user = User(id=1, name='ooxx')
<(user)
sessionmit()
或者使⽤ MySQL 的 INSERT … ON DUPLICATE KEY UPDATE，需要⽤到 @compiles 装饰器，有点难懂，⾃⼰搜索看吧：《SQLAlchemy ON DUPLICATE KEY UPDATE》和 sqlalchemy_mysql_ext。
如何使⽤⽆符号整数？
可以使⽤ MySQL 的⽅⾔：
from sql import INTEGER
id = Column(INTEGER(unsigned=True), primary_key=True)
模型的属性名需要和表的字段名不⼀样怎么办？
开发时遇到过⼀个奇怪的需求，有个其他系统的表⾥包含了⼀个“from”字段，这在 Python ⾥是关键字，于是只能这样处理了：
from_ = Column('from', CHAR(10))
如何获取字段的长度？
Column 会⽣成⼀个很复杂的对象，想获取长度⽐较⿇烦，这⾥以 User.name 为例：
User.lumns[0].type.length
如何指定使⽤ InnoDB，以及使⽤ UTF-8 编码？
最简单的⽅式就是修改数据库的默认配置。如果⾮要在代码⾥指定的话，可以这样：
class User(BaseModel):
'mysql_charset': 'utf8'
}
MySQL 5.5 开始⽀持存储 4 字节的 UTF-8 编码的字符了，iOS ⾥⾃带的 emoji（如 字符）就属于这种。
如果是对表来设置的话，可以把上⾯代码中的 utf8 改成 utf8mb4，DB_CONNECT_STRING ⾥的 charset 也这样更改。
如果对库或字段来设置，则还是⾃⼰写 SQL 语句⽐较⽅便，具体细节可参考《How to support full Unicode in MySQL databases》。
不建议全⽤ utf8mb4 代替 utf8，因为前者更慢，索引会占⽤更多空间。
如何设置外键约束？
1from random import randint
2from sqlalchemy import ForeignKey
3
4class User(BaseModel):
5 __tablename__ = 'user'
6 id = Column(Integer, primary_key=True)
7 age = Column(Integer)
8
9class Friendship(BaseModel):
10 __tablename__ = 'friendship'
11 id = Column(Integer, primary_key=True)
12 user_id1 = Column(Integer, ForeignKey('user.id'))
13 user_id2 = Column(Integer, ForeignKey('user.id'))
14
15for i in xrange(100):
16 session.add(User(age=randint(1, 100)))
17 session.flush() # 或 sessionmit()，执⾏完后，user 对象的 id 属性才可以访问（因为 id 是⾃增的）
18for i in xrange(100):
19 session.add(Friendship(user_id1=randint(1, 100), user_id2=randint(1, 100)))
20 sessionmit()
21 session.query(User).filter(User.age < 50).delete()
执⾏这段代码时，你应该会遇到⼀个错误：
原因是删除 user 表的数据，可能会导致 friendship 的外键不指向⼀个真实存在的记录。在默认情况下，MySQL 会拒绝这种操作，也就是 RESTRICT。InnoDB 还允许指定 ON
DELETE 为 CASCADE 和 SET NULL，前者会删除 friendship 中⽆效的记录，后者会将这些记录的外键设为 NULL。
除了删除，还有可能更改主键，这也会导致 friendship 的外键失效。于是相应的就有 ON UPDATE 了。其中 CASCADE 变成了更新相应的外键，⽽不是删除。
⽽在 SQLAlchemy 中是这样处理的：
class Friendship(BaseModel):
__tablename__ = 'friendship'
id = Column(Integer, primary_key=True)
user_id1 = Column(Integer, ForeignKey('user.id', ondelete='CASCADE', onupdate='CASCADE'))
user_id2 = Column(Integer, ForeignKey('user.id', ondelete='CASCADE', onupdate='CASCADE'))
如何连接表？
1from sqlalchemy import distinct
import aliased
3
4 Friend = aliased(User, name='Friend')
5 print session.query(User.id).join(Friendship, User.id == Friendship.user_id1).all() # 所有有朋友的⽤户
6 print session.query(distinct(User.id)).join(Friendship, User.id == Friendship.user_id1).all() # 所有有朋友的⽤户（去掉重复的）
7 print session.query(User.id).join(Friendship, User.id == Friendship.user_id1).distinct().all() # 同上
8 print session.query(Friendship.user_id2).join(User, User.id == Friendship.user_id1).order_by(Friendship.user_id2).distinct().all() # 所有被别⼈当成朋友的⽤户
9 print session.query(Friendship.user_id2).select_from(User).join(Friendship, User.id == Friendship.user_id1).order_by(Friendship.user_id2).distinct().all() # 同上，join 的⽅向相反，但因为不是 STRAIGHT_JOIN，所以 MySQL 可以⾃⼰选择顺序
10 print session.query(User.id, Friendship.user_id2).join(Friendship, User.id == Friendship.user_id1).all() # ⽤户及其朋友
11 print session.query(User.id, Friendship.user_id2).join(Friendship, User.id == Friendship.user_id1).filter(User.id < 10).all() # id ⼩于10的⽤户及其朋友
12 print session.query(User.id, Friend.id).join(Friendship, User.id == Friendship.user_id1).join(Friend, Friend.id == Friendship.user_id2).all() # 两次 join，由于使⽤到相同的表，因此需要别名
13 print session.query(User.id, Friendship.user_id2).outerjoin(Friendship, User.id == Friendship.user_id1).all() # ⽤户及其朋友（⽆朋友则为 None，使⽤左连接）
这⾥我没提到 relationship，虽然它看上去很⽅便，但需要学习的内容实在太多，还要考虑很多性能上的问题，所以⼲脆⾃⼰ join 吧。
为什么⽆法删除 in 操作查询出来的记录？
session.query(User).filter(User.id.in_((1, 2, 3))).delete()
抛出这样的异常：
但这样是没问题的：
session.query(User).filter(or_(User.id == 1, User.id == 2, User.id == 3)).delete()
搜了下到《Sqlalchemy delete subquery》这个问题，提到了 delete 的⼀个注意点：删除记录时，默认会尝试删除 session 中符合条件的对象，⽽ in 操作估计还不⽀持，于是
就出错了。解决办法就是删除时不进⾏同步，然后再让 session ⾥的所有实体都过期：
session.query(User).filter(User.id.in_((1, 2, 3))).delete(synchronize_session=False)
sessionmit() # pire_all()
此外，update 操作也有同样的参数，如果后⾯⽴刻提交了，那么加上 synchronize_session=False 参数会更快。
如何扩充模型的基类？
declarative_base() 会⽣成⼀个 class 对象，这个对象的⼦类⼀般都和⼀张表对应。如果想增加这个基类的⽅法或属性，让⼦类都能使⽤，可以有三种⽅法：
1.定义⼀个新类，将它的⽅法设置为基类的⽅法：
1class ModelMixin(object):
2 @classmethod
3 def get_by_id(cls, session, id, columns=None, lock_mode=None):
4if hasattr(cls, 'id'):
5 scalar = False
6if columns:
7if isinstance(columns, (tuple, list)):
8 query = session.query(*columns)
9else:
10 scalar = True
11 query = session.query(columns)
12else:
13 query = session.query(cls)
14if lock_mode:
15 query = query.with_lockmode(lock_mode)
16 query = query.filter(cls.id == id)
17if scalar:
18return query.scalar()
19return query.first()
21 _by_id = get_by_id
22 @classmethod
23 def get_all(cls, session, columns=None, offset=None, limit=None, order_by=None, lock_mode=None):
24if columns:
25if isinstance(columns, (tuple, list)):
26 query = session.query(*columns)
27else:
28 query = session.query(columns)
29if isinstance(columns, str):
30 query = query.select_from(cls)
31else:
32 query = session.query(cls)
33if order_by is not None:
34if isinstance(order_by, (tuple, list)):
35 query = der_by(*order_by)
36else:
37 query = der_by(order_by)
38if offset:
39 query = query.offset(offset)
40if limit:
41 query = query.limit(limit)
42if lock_mode:
43 query = query.with_lockmode(lock_mode)
44return query.all()
45 _all = get_all
46 @classmethod
47 def count_all(cls, session, lock_mode=None):
48 query = session.unt('*')).select_from(cls)
49if lock_mode:
50 query = query.with_lockmode(lock_mode)
51return query.scalar()
52 unt_all = count_all
53 @classmethod
54 def exist(cls, session, id, lock_mode=None):
55if hasattr(cls, 'id'):
56 query = session.unt('*')).select_from(cls).filter(cls.id == id)
57if lock_mode:
58 query = query.with_lockmode(lock_mode)
59return query.scalar() > 0
60return False
字符串长度怎么数python
61 ist = exist
62 @classmethod
63 def set_attr(cls, session, id, attr, value):
64if hasattr(cls, 'id'):
65 session.query(cls).filter(cls.id == id).update({
66 attr: value
67 })
68 sessionmit()
69 BaseModel.set_attr = set_attr
70 @classmethod
71 def set_attrs(cls, session, id, attrs):
72if hasattr(cls, 'id'):
73 session.query(cls).filter(cls.id == id).update(attrs)
74 sessionmit()
75 BaseModel.set_attrs = set_attrs
虽然很拙劣，但确实能⽤。顺便还附送了⼀些有⽤的玩意，你懂的。
2.设置 declarative_base() 的 cls 参数：
BaseModel = declarative_base(cls=ModelMixin)
这种⽅法不需要执⾏“_by_id = get_by_id”之类的代码。不⾜之处就是 PyCharm 仍然⽆法到这些⽅法的位置。
3.设置 __abstract__ 属性：
class BaseModel(BaseModel):
__abstract__ = True
__table_args__ = { # 可以省掉⼦类的 __table_args__ 了
'mysql_engine': 'InnoDB',
'mysql_charset': 'utf8'
}
# ...
这种⽅法最简单，也可以继承出多个类。
如何正确使⽤事务？
假设有⼀个简单的银⾏系统，⼀共两名⽤户：
class User(BaseModel):
__tablename__ = 'user'
id = Column(Integer, primary_key=True)
money = Column(DECIMAL(10, 2))
class TanseferLog(BaseModel):
__tablename__ = 'tansefer_log'
id = Column(Integer, primary_key=True)
from_user = Column(Integer, ForeignKey('user.id', ondelete='CASCADE', onupdate='CASCADE'))
to_user = Column(Integer, ForeignKey('user.id', ondelete='CASCADE', onupdate='CASCADE'))
amount = Column(DECIMAL(10, 2))
user = User(money=100)
session.add(user)
user = User(money=0)
session.add(user)
sessionmit()
然后开两个 session，同时进⾏两次转账操作：
1 session1 = DB_Session()
2 session2 = DB_Session()
3 user1 = session1.query(User).get(1)
4 user2 = session1.query(User).get(2)
>= 100:
6 -= 100
7 += 100
8 session1.add(TanseferLog(from_user=1, to_user=2, amount=100))
9 user1 = session2.query(User).get(1)
10 user2 = session2.query(User).get(2)
>= 100:
12 -= 100
13 += 100
14 session2.add(TanseferLog(from_user=1, to_user=2, amount=100))
15 session1mit()
16 session2mit()
现在看看结果：
>>>
Decimal('0.00')
>>>
>>> session.query(TanseferLog).count()
2L
两次转账都成功了，但是只转⾛了⼀笔钱，这明显不科学。
可见 MySQL InnoDB 虽然⽀持事务，但并不是那么简单的，还需要⼿动加锁。
⾸先来试试读锁：
1 user1 = session1.query(User).with_lockmode('read').get(1)
2 user2 = session1.query(User).with_lockmode('read').get(2)
>= 100:
4 -= 100
5 += 100
6 session1.add(TanseferLog(from_user=1, to_user=2, amount=100))
7 user1 = session2.query(User).with_lockmode('read').get(1)
8 user2 = session2.query(User).with_lockmode('read').get(2)
>= 100:
10 -= 100
11 += 100
12 session2.add(TanseferLog(from_user=1, to_user=2, amount=100))
13 session1mit()
14 session2mit()
现在在执⾏ session1mit() 的时候，因为 user1 和 user2 都被 session2 加了读锁，所以会等待锁被释放。超时以后，session1mit() 会抛出个超时的异常，如果捕捉了的话，或者 session2 在另⼀个进程，那么 session2mit() 还是能正常提交的。这种情况下，有⼀个事务是肯定会提交失败的，所以那些更改等于⽩做了。
接下来看看写锁，把上段代码中的 'read' 改成 'update' 即可。这次在执⾏ select 的时候就会被阻塞了：
user1 = session2.query(User).with_lockmode('update').get(1)
这样只要在超时期间内，session1 完成了提交或回滚，那么 session2 就能正常判断 >= 100 是否成⽴了。
由此可见，如果需要更改数据，最好加写锁。
那么什么时候⽤读锁呢？如果要保证事务运⾏期间内，被读取的数据不被修改，⾃⼰也不去修改，加读锁即可。
举例来说，假设我查询⼀个⽤户的开⽀记录（同时包含余额和转账记录），可以直接把 user 和 tansefer_log 做个内连接。
但如果⽤户的转账记录特别多，我在查询前想先验证⽤户的密码（假设在 user 表中），确认相符后才查询转账记录。⽽这两次查询的期间内，⽤户可能收到了⼀笔转账，导致他的 money 字段被修改了，但我在展⽰给⽤户时，⽤户的余额仍然没变，这就不正常了。
⽽如果我在读取 user 时加了读锁，⽤户是⽆法收到转账的（因为⽆法被另⼀个事务加写锁来修改 mone
y 字段），这就保证了不会查出额外的 tansefer_log 记录。等我查询完两张表，释放了读锁后，转账就可以继续进⾏了，不过我显⽰的数据在当时的确是正确和⼀致的。
另外要注意的是，如果被查询的字段没有加索引的话，就会变成锁整张表了：
1 session1.query(User).filter(User.id > 50).with_lockmode('update').all()
2 session2.query(User).filter(User.id < 40).with_lockmode('update').all() # 不会被锁，因为 id 是主键
llback()
llback()
5 session1.query(User). == 50).with_lockmode('update').all()
6 session2.query(User). == 40).with_lockmode('update').all() # 会等待解锁，因为 money 上没有索引
要避免的话，可以这样：
money = Column(DECIMAL(10, 2), index=True)
另⼀个注意点是⼦事务。
InnoDB ⽀持⼦事务（savepoint 语句），可以简化⼀些逻辑。
例如有的⽅法是⽤于改写数据库的，它执⾏时可能提交了事务，但在后续的流程中却执⾏失败了，却没法回滚那个⽅法中已经提交的事务。这时就可以把那个⽅法当成⼦事务来运⾏了：
1 def step1():
2 # ...
3if success:
4 sessionmit()
5return True
6 llback()
7return False
8 def step2():
9 # ...
10if success:
11 sessionmit()
12return True
13 llback()
14return False
15 session.begin_nested()
16if step1():
17 session.begin_nested()
18if step2():
19 sessionmit()
20else:
21 llback()
22else:
23 llback()
此外，rollback ⼀个⼦事务，可以释放这个⼦事务中获得的锁，提⾼并发性和降低死锁概率。
如何对⼀个字段进⾏⾃增操作？
最简单的办法就是获取时加上写锁：
user = session.query(User).with_lockmode('update').get(1)
user.age += 1
sessionmit()
如果不想多⼀次读的话，这样写也是可以的：
1 session.query(User).filter(User.id == 1).update({
2 User.age: User.age + 1
3 })
4 sessionmit()
5 # 其实字段之间也可以做运算：
6 session.query(User).filter(User.id == 1).update({
7 User.age: User.age + User.id
8 })
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论