pythonsqlalchemy怎么看到返回的具体内容_Python SQLAlchemy基本操作和常用技巧

session.query(User.name).prefix_with('HIGH_PRIORITY').all()

session.execute(User.__table__.insert().prefix_with('IGNORE'), {'id': 1, 'name': '1'})

如何替换一个已有主键的记录？

使用 session.merge() 方法替代 session.add()，其实就是 SELECT + UPDATE：

user = User(id=1, name='ooxx')

session.merge(user)

session.commit()

或者使用 MySQL 的 INSERT … ON DUPLICATE KEY UPDATE，需要用到 @compiles 装饰器，有点难懂，搜索：《SQLAlchemy ON DUPLICATE KEY UPDATE》 和 sqlalchemy_mysql_ext查看。

如何使用无符号整数？

1 from sqlalchemy.dialects.mysql importINTEGER2 id = Column(INTEGER(unsigned=True), primary_key=True)

模型的属性名需要和表的字段名不一样怎么办？

1 from_ = Column('from', CHAR(10))

如何获取字段的长度？

Column 会生成一个很复杂的对象，想获取长度比较麻烦，这里以 User.name 为例：

1 User.name.property.columns[0].type.length

如何指定使用 InnoDB，以及使用 UTF-8 编码？最简单的方式就是修改数据库的默认配置。如果非要在代码里指定的话，可以这样：

classUser(BaseModel):__table_args__ ={'mysql_engine': 'InnoDB','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，因为前者更慢，索引会占用更多空间。

如何设置外键约束？

1 from random importrandint2 from sqlalchemy importForeignKey3

4

5 classUser(BaseModel):6 __tablename__ = 'user'

7

8 id = Column(Integer, primary_key=True)9 age =Column(Integer)10

11

12 classFriendship(BaseModel):13 __tablename__ = 'friendship'

14

15 id = Column(Integer, primary_key=True)16 user_id1 = Column(Integer, ForeignKey('user.id'))17 user_id2 = Column(Integer, ForeignKey('user.id'))18

19

20 for i in xrange(100):21 session.add(User(age=randint(1, 100)))22 session.flush() #或 session.commit()，执行完后，user 对象的 id 属性才可以访问(因为 id 是自增的)

23

24 for i in xrange(100):25 session.add(Friendship(user_id1=randint(1, 100), user_id2=randint(1, 100)))26 session.commit()27

28 session.query(User).filter(User.age < 50).delete()

执行这段代码时，你应该会遇到一个错误：

1 sqlalchemy.exc.IntegrityError: (IntegrityError) (1451, 'Cannot delete or update a parent row: a foreign key constraint fails (`ooxx`.`friendship`, CONSTRAINT `friendship_ibfk_1` FOREIGN KEY (`user_id1`) REFERENCES `user` (`id`))') 'DELETE FROM user WHERE user.age < %s' (50,)

原因是删除 user 表的数据，可能会导致 friendship 的外键不指向一个真实存在的记录。在默认情况下，MySQL 会拒绝这种操作，也就是 RESTRICT。InnoDB 还允许指定 ON DELETE 为 CASCADE 和 SET NULL，前者会删除 friendship 中无效的记录，后者会将这些记录的外键设为 NULL。

除了删除，还有可能更改主键，这也会导致 friendship 的外键失效。于是相应的就有 ON

UPDATE 了。其中 CASCADE 变成了更新相应的外键，而不是删除。

而在 SQLAlchemy 中是这样处理的：

1 classFriendship(BaseModel):2 __tablename__ = 'friendship'

3

4 id = Column(Integer, primary_key=True)5 user_id1 = Column(Integer, ForeignKey('user.id', ondelete='CASCADE', onupdate='CASCADE'))6 user_id2 = Column(Integer, ForeignKey('user.id', ondelete='CASCADE', onupdate='CASCADE'))

如何连接表？

from sqlalchemy importdistinctfrom sqlalchemy.orm importaliased

Friend= aliased(User, name='Friend')print session.query(User.id).join(Friendship, User.id == Friendship.user_id1).all() #所有有朋友的用户

print session.query(distinct(User.id)).join(Friendship, User.id == Friendship.user_id1).all() #所有有朋友的用户(去掉重复的)

print session.query(User.id).join(Friendship, User.id == Friendship.user_id1).distinct().all() #同上

print session.query(Friendship.user_id2).join(User, User.id == Friendship.user_id1).order_by(Friendship.user_id2).distinct().all() #所有被别人当成朋友的用户

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 可以自己选择顺序

print session.query(User.id, Friendship.user_id2).join(Friendship, User.id == Friendship.user_id1).all() #用户及其朋友

print session.query(User.id, Friendship.user_id2).join(Friendship, User.id == Friendship.user_id1).filter(User.id < 10).all() #id 小于 10 的用户及其朋友

print session.query(User.id, Friend.id).join(Friendship, User.id == Friendship.user_id1).join(Friend, Friend.id == Friendship.user_id2).all() #两次 join，由于使用到相同的表，因此需要别名

print session.query(User.id, Friendship.user_id2).outerjoin(Friendship, User.id == Friendship.user_id1).all() #用户及其朋友(无朋友则为 None，使用左连接)

这里我没提到 relationship，虽然它看上去很方便，但需要学习的内容实在太多，还要考虑很多性能上的问题，所以干脆自己 join 吧。

为什么无法删除 in 操作查询出来的记录？

1 session.query(User).filter(User.id.in_((1, 2, 3))).delete()

抛出这样的异常：

sqlalchemy.exc.InvalidRequestError: Could not evaluate current criteria in Python. Specify 'fetch' or False for the synchronize_session parameter.

但这样是没问题的：

1 session.query(User).filter(or_(User.id == 1, User.id == 2, User.id == 3)).delete()

搜了下找到《Sqlalchemy delete subquery》这个问题，提到了 delete 的一个注意点：删除记录时，默认会尝试删除 session 中符合条件的对象，而 in 操作估计还不支持，于是就出错了。解决办法就是删除时不进行同步，然后再让 session 里的所有实体都过期：

1 session.query(User).filter(User.id.in_((1, 2, 3))).delete(synchronize_session=False)2 session.commit() #or session.expire_all()

此外，update 操作也有同样的参数，如果后面立刻提交了，那么加上 synchronize_session=False 参数会更快。

如何扩充模型的基类？declarative_base() 会生成一个 class 对象，这个对象的子类一般都和一张表对应。如果想增加这个基类的方法或属性，让子类都能使用，可以有三种方法：

1.定义一个新类，将它的方法设置为基类的方法：

1 classModelMixin(object):2 @classmethod3 def get_by_id(cls, session, id, columns=None, lock_mode=None):4 if hasattr(cls, 'id'):5 scalar =False6 ifcolumns:7 ifisinstance(columns, (tuple, list)):8 query = session.query(*columns)9 else:10 scalar =True11 query =session.query(columns)12 else:13 query =session.query(cls)14 iflock_mode:15 query =query.with_lockmode(lock_mode)16 query = query.filter(cls.id ==id)17 ifscalar:18 returnquery.scalar()19 returnquery.first()20 returnNone21 BaseModel.get_by_id =get_by_id22 @classmethod23 def get_all(cls, session, columns=None, offset=None, limit=None, order_by=None, lock_mode=None):24 ifcolumns:25 ifisinstance(columns, (tuple, list)):26 query = session.query(*columns)27 else:28 query =session.query(columns)29 ifisinstance(columns, str):30 query =query.select_from(cls)31 else:32 query =session.query(cls)33 if order_by is notNone:34 ifisinstance(order_by, (tuple, list)):35 query = query.order_by(*order_by)36 else:37 query =query.order_by(order_by)38 ifoffset:39 query =query.offset(offset)40 iflimit:41 query =query.limit(limit)42 iflock_mode:43 query =query.with_lockmode(lock_mode)44 returnquery.all()45 BaseModel.get_all =get_all46 @classmethod47 def count_all(cls, session, lock_mode=None):48 query = session.query(func.count('*')).select_from(cls)49 iflock_mode:50 query =query.with_lockmode(lock_mode)51 returnquery.scalar()52 BaseModel.count_all =count_all53 @classmethod54 def exist(cls, session, id, lock_mode=None):55 if hasattr(cls, 'id'):56 query = session.query(func.count('*')).select_from(cls).filter(cls.id ==id)57 iflock_mode:58 query =query.with_lockmode(lock_mode)59 return query.scalar() >060 returnFalse61 BaseModel.exist =exist62 @classmethod63 defset_attr(cls, session, id, attr, value):64 if hasattr(cls, 'id'):65 session.query(cls).filter(cls.id ==id).update({66 attr: value67 })68 session.commit()69 BaseModel.set_attr =set_attr70 @classmethod71 defset_attrs(cls, session, id, attrs):72 if hasattr(cls, 'id'):73 session.query(cls).filter(cls.id ==id).update(attrs)74 session.commit()75 BaseModel.set_attrs = set_attrs

虽然很拙劣，但确实能用。顺便还附送了一些有用的玩意。

2.设置 declarative_base() 的 cls 参数：

1 BaseModel = declarative_base(cls=ModelMixin)

这种方法不需要执行“BaseModel.get_by_id = get_by_id”之类的代码。不足之处就是 PyCharm 仍然无法找到这些方法的位置。

3.设置 __abstract__ 属性：

1 classBaseModel(BaseModel):2 __abstract__ =True3 __table_args__ = { #可以省掉子类的 __table_args__ 了

4 'mysql_engine': 'InnoDB',5 'mysql_charset': 'utf8'

6 }7 #...

这种方法最简单，也可以继承出多个类。

如何正确使用事务？假设有一个简单的银行系统，一共两名用户：

1 classUser(BaseModel):2 __tablename__ = 'user'

3 id = Column(Integer, primary_key=True)4 money = Column(DECIMAL(10, 2))5 classTanseferLog(BaseModel):6 __tablename__ = 'tansefer_log'

7 id = Column(Integer, primary_key=True)8 from_user = Column(Integer, ForeignKey('user.id', ondelete='CASCADE', onupdate='CASCADE'))9 to_user = Column(Integer, ForeignKey('user.id', ondelete='CASCADE', onupdate='CASCADE'))10 amount = Column(DECIMAL(10, 2))11 user = User(money=100)12 session.add(user)13 user = User(money=0)14 session.add(user)15 session.commit()

然后开两个 session，同时进行两次转账操作：

1 session1 =DB_Session()2 session2 =DB_Session()3 user1 = session1.query(User).get(1)4 user2 = session1.query(User).get(2)5 if user1.money >= 100:6 user1.money -= 100

7 user2.money += 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)11 if user1.money >= 100:12 user1.money -= 100

13 user2.money += 100

14 session2.add(TanseferLog(from_user=1, to_user=2, amount=100))15 session1.commit()16 session2.commit()

现在看看结果：

>>>user1.money

Decimal('0.00')>>>user2.money

Decimal('100.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)3 if user1.money >= 100:4 user1.money -= 100

5 user2.money += 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)9 if user1.money >= 100:10 user1.money -= 100

11 user2.money += 100

12 session2.add(TanseferLog(from_user=1, to_user=2, amount=100))13 session1.commit()14 session2.commit()

现在在执行 session1.commit() 的时候，因为 user1 和 user2 都被 session2 加了读锁，所以会等待锁被释放。超时以后，session1.commit() 会抛出个超时的异常，如果捕捉了的话，或者 session2 在另一个进程，那么 session2.commit() 还是能正常提交的。这种情况下，有一个事务是肯定会提交失败的，所以那些更改等于白做了。

接下来看看写锁，把上段代码中的 'read' 改成 'update' 即可。这次在执行 select 的时候就会被阻塞了：

user1 = session2.query(User).with_lockmode('update').get(1)

这样只要在超时期间内，session1

完成了提交或回滚，那么 session2 就能正常判断 user1.money >= 100

是否成立了。

由此可见，如果需要更改数据，最好加写锁。

那么什么时候用读锁呢？如果要保证事务运行期间内，被读取的数据不被修改，自己也不去修改，加读锁即可。

举例来说，假设我查询一个用户的开支记录(同时包含余额和转账记录)，可以直接把

user 和 tansefer_log 做个内连接。

但如果用户的转账记录特别多，我在查询前想先验证用户的密码(假设在 user

表中)，确认相符后才查询转账记录。而这两次查询的期间内，用户可能收到了一笔转账，导致他的 money

字段被修改了，但我在展示给用户时，用户的余额仍然没变，这就不正常了。

而如果我在读取 user

时加了读锁，用户是无法收到转账的(因为无法被另一个事务加写锁来修改 money 字段)，这就保证了不会查出额外的 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 是主键

3 session1.rollback()4 session2.rollback()5 session1.query(User).filter(User.money == 50).with_lockmode('update').all()6 session2.query(User).filter(User.money == 40).with_lockmode('update').all() #会等待解锁，因为 money 上没有索引

要避免的话，可以这样：

1 money = Column(DECIMAL(10, 2), index=True)

另一个注意点是子事务。

InnoDB 支持子事务(savepoint

语句)，可以简化一些逻辑。

例如有的方法是用于改写数据库的，它执行时可能提交了事务，但在后续的流程中却执行失败了，却没法回滚那个方法中已经提交的事务。这时就可以把那个方法当成子事务来运行了：

1 defstep1():2 #...

3 ifsuccess:4 session.commit()5 returnTrue6 session.rollback()7 returnFalse8 defstep2():9 #...

10 ifsuccess:11 session.commit()12 returnTrue13 session.rollback()14 returnFalse15 session.begin_nested()16 ifstep1():17 session.begin_nested()18 ifstep2():19 session.commit()20 else:21 session.rollback()22 else:23 session.rollback()

此外，rollback 一个子事务，可以释放这个子事务中获得的锁，提高并发性和降低死锁概率。

如何对一个字段进行自增操作？

最简单的办法就是获取时加上写锁：

1 user = session.query(User).with_lockmode('update').get(1)2 user.age += 1

3 session.commit()

如果不想多一次读的话，这样写也是可以的：

1 session.query(User).filter(User.id == 1).update({2 User.age: User.age + 1

3 })4 session.commit()5 #其实字段之间也可以做运算：

6 session.query(User).filter(User.id == 1).update({7 User.age: User.age +User.id8 })