首先說下,因爲最新的 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 })