首先说下,因为最新的 0.8 版仍是开发版本,所以我使用的是 0.79 版,API 也许会有些不一样。
由于我是搭配 MySQL InnoDB 使用,因此使用其余数据库的也不能彻底照搬本文。python
接着就从安装开始介绍吧,以 Debian/Ubuntu 为例(请确保有管理员权限):
1.MySQLmysql
apt-get install mysql-server apt-get install mysql-client apt-get install libmysqlclient15-dev
2.python-mysqldbweb
apt-get install python-mysqldb
3.easy_installsql
wget http://peak.telecommunity.com/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 不是很搭。不过性能其实很好,所以之后再去研究下其余方案吧……session
装好后就能够开始使用了:并发
from sqlalchemy import create_engine from sqlalchemy.orm 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() 里初始化:dom
class BaseHandler(tornado.web.RequestHandler): def initialize(self): self.session = models.DB_Session() def on_finish(self): self.session.close()
对其余 Web 服务器来讲,可使用 sqlalchemy.orm.scoped_session,它能保证每一个线程得到的 session 对象都是惟一的。不过 Tornado 自己就是单线程的,若是使用了异步方式,就可能会出现问题,所以我并没使用它。异步
拿到 session 后,就能够执行 SQL 了:
1 session.execute('create database abc') 2 print session.execute('show databases').fetchall() 3 session.execute('use abc') 4 # 建 user 表的过程略 5 print session.execute('select * from user where id = 1').first() 6 print session.execute('select * from user where id = :id', {'id': 1}).first()
不过这和直接使用 MySQL-Python 没啥区别,因此就不介绍了;我仍是喜欢 ORM 的方式,这也是我采用 SQLAlchemy 的惟一缘由。
因而来定义一个表:
1 from sqlalchemy import Column 2 from sqlalchemy.types import CHAR, Integer, String 3 from sqlalchemy.ext.declarative import declarative_base 4 5 BaseModel = declarative_base() 6 def init_db(): 7 BaseModel.metadata.create_all(engine) 8 def drop_db(): 9 BaseModel.metadata.drop_all(engine) 10 11 class 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 还有一些其余的参数,我就不解释了。
最后,BaseModel.metadata.create_all(engine) 会找到 BaseModel 的全部子类,并在数据库中创建这些表;drop_all() 则是删除这些表。
接着就开始使用这个表吧:
1 from 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 session.commit() 12 query = session.query(User) 13 print query # 显示SQL 语句 14 print query.statement # 同上 15 for user in query: # 遍历时查询 16 print user.name 17 print query.all() # 返回的是一个相似列表的对象 18 print query.first().name # 记录不存在时,first() 会返回 None 19 # print query.one().name # 不存在,或有多行记录时会抛出异常 20 print query.filter(User.id == 2).first().name 21 print query.get(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 print query2.order_by(User.name).all() 28 print query2.order_by('name').all() 29 print query2.order_by(User.name.desc()).all() 30 print query2.order_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 print query4.count() 46 print session.query(func.count('*')).select_from(User).scalar() 47 print session.query(func.count('1')).select_from(User).scalar() 48 print session.query(func.count(User.id)).scalar() 49 print session.query(func.count('*')).filter(User.id > 0).scalar() # filter() 中包含 User,所以不须要指定表 50 print session.query(func.count('*')).filter(User.name == 'a').limit(1).scalar() == 1 # 能够用 limit() 限制 count() 的返回数 51 print session.query(func.sum(User.id)).scalar() 52 print session.query(func.now()).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 = query.get(1) 57 print user.name 58 user.name = 'd' 59 session.flush() # 写数据库,但并不提交 60 print query.get(1).name 61 session.delete(user) 62 session.flush() 63 print query.get(1) 64 session.rollback() 65 print query.get(1).name 66 query.filter(User.id == 1).delete() 67 session.commit() 68 print query.get(1)
增删改查都涉及到了,本身看看输出的 SQL 语句就知道了,因而基础知识就介绍到此了。
下面开始介绍一些进阶的知识。
如何批量插入大批数据?
可使用非 ORM 的方式:
session.execute( User.__table__.insert(), [{'name': `randint(1, 100)`,'age': randint(1, 100)} for i in xrange(10000)] ) session.commit()
上面我批量插入了 10000 条记录,半秒内就执行完了;而 ORM 方式会花掉很长时间。
如何让执行的 SQL 语句增长前缀?
使用 query 对象的 prefix_with() 方法:
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。
如何使用无符号整数?
可使用 MySQL 的方言:
from sqlalchemy.dialects.mysql import INTEGER id = Column(INTEGER(unsigned=True), primary_key=True)
模型的属性名须要和表的字段名不同怎么办?
开发时遇到过一个奇怪的需求,有个其余系统的表里包含了一个“from”字段,这在 Python 里是关键字,因而只能这样处理了:
from_ = Column('from', CHAR(10))
如何获取字段的长度?
Column 会生成一个很复杂的对象,想获取长度比较麻烦,这里以 User.name 为例:
User.name.property.columns[0].type.length
如何指定使用 InnoDB,以及使用 UTF-8 编码?
最简单的方式就是修改数据库的默认配置。若是非要在代码里指定的话,能够这样:
class User(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 import randint 2 from sqlalchemy import ForeignKey 3 4 class User(BaseModel): 5 __tablename__ = 'user' 6 id = Column(Integer, primary_key=True) 7 age = Column(Integer) 8 9 class 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 15 for i in xrange(100): 16 session.add(User(age=randint(1, 100))) 17 session.flush() # 或 session.commit(),执行完后,user 对象的 id 属性才能够访问(由于 id 是自增的) 18 for i in xrange(100): 19 session.add(Friendship(user_id1=randint(1, 100), user_id2=randint(1, 100))) 20 session.commit() 21 session.query(User).filter(User.age < 50).delete()
执行这段代码时,你应该会遇到一个错误:
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 中是这样处理的:
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'))
如何链接表?
1 from sqlalchemy import distinct 2 from sqlalchemy.orm 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()
抛出这样的异常:
sqlalchemy.exc.InvalidRequestError: Could not evaluate current criteria in Python. Specify 'fetch' or False for the synchronize_session parameter.
但这样是没问题的:
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) session.commit() # or session.expire_all()
此外,update 操做也有一样的参数,若是后面马上提交了,那么加上 synchronize_session=False 参数会更快。
如何扩充模型的基类?
declarative_base() 会生成一个 class 对象,这个对象的子类通常都和一张表对应。若是想增长这个基类的方法或属性,让子类都能使用,能够有三种方法:
1.定义一个新类,将它的方法设置为基类的方法:
1 class ModelMixin(object): 2 @classmethod 3 def get_by_id(cls, session, id, columns=None, lock_mode=None): 4 if hasattr(cls, 'id'): 5 scalar = False 6 if columns: 7 if isinstance(columns, (tuple, list)): 8 query = session.query(*columns) 9 else: 10 scalar = True 11 query = session.query(columns) 12 else: 13 query = session.query(cls) 14 if lock_mode: 15 query = query.with_lockmode(lock_mode) 16 query = query.filter(cls.id == id) 17 if scalar: 18 return query.scalar() 19 return query.first() 20 return None 21 BaseModel.get_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): 24 if columns: 25 if isinstance(columns, (tuple, list)): 26 query = session.query(*columns) 27 else: 28 query = session.query(columns) 29 if isinstance(columns, str): 30 query = query.select_from(cls) 31 else: 32 query = session.query(cls) 33 if order_by is not None: 34 if isinstance(order_by, (tuple, list)): 35 query = query.order_by(*order_by) 36 else: 37 query = query.order_by(order_by) 38 if offset: 39 query = query.offset(offset) 40 if limit: 41 query = query.limit(limit) 42 if lock_mode: 43 query = query.with_lockmode(lock_mode) 44 return query.all() 45 BaseModel.get_all = get_all 46 @classmethod 47 def count_all(cls, session, lock_mode=None): 48 query = session.query(func.count('*')).select_from(cls) 49 if lock_mode: 50 query = query.with_lockmode(lock_mode) 51 return query.scalar() 52 BaseModel.count_all = count_all 53 @classmethod 54 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 if lock_mode: 58 query = query.with_lockmode(lock_mode) 59 return query.scalar() > 0 60 return False 61 BaseModel.exist = exist 62 @classmethod 63 def set_attr(cls, session, id, attr, value): 64 if hasattr(cls, 'id'): 65 session.query(cls).filter(cls.id == id).update({ 66 attr: value 67 }) 68 session.commit() 69 BaseModel.set_attr = set_attr 70 @classmethod 71 def set_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 参数:
BaseModel = declarative_base(cls=ModelMixin)
这种方法不须要执行“BaseModel.get_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) 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 上没有索引
要避免的话,能够这样:
money = Column(DECIMAL(10, 2), index=True)
另外一个注意点是子事务。
InnoDB 支持子事务(savepoint 语句),能够简化一些逻辑。
例若有的方法是用于改写数据库的,它执行时可能提交了事务,但在后续的流程中却执行失败了,却无法回滚那个方法中已经提交的事务。这时就能够把那个方法当成子事务来运行了:
1 def step1(): 2 # ... 3 if success: 4 session.commit() 5 return True 6 session.rollback() 7 return False 8 def step2(): 9 # ... 10 if success: 11 session.commit() 12 return True 13 session.rollback() 14 return False 15 session.begin_nested() 16 if step1(): 17 session.begin_nested() 18 if step2(): 19 session.commit() 20 else: 21 session.rollback() 22 else: 23 session.rollback()
此外,rollback 一个子事务,能够释放这个子事务中得到的锁,提升并发性和下降死锁几率。
如何对一个字段进行自增操做?
最简单的办法就是获取时加上写锁:
user = session.query(User).with_lockmode('update').get(1) user.age += 1 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.id 8 })