首先說下,由于最新的 0.8 版還是開發版本,因此我使用的是 0.79 版,API 也許會有些不同。
因為我是搭配 MySQL InnoDB 使用,所以使用其他數據庫的也不能完全照搬本文。
接著就從安裝開始介紹吧,以 Debian/Ubuntu 為例(請確保有管理員權限):
1.MySQL
如果是用其他操作系統,遇到問題就 Google 一下吧。我是在 Mac OS X 上開發的,途中也遇到些問題,不過當時沒記下來……
值得一提的是我用了 MySQL-Python 來連 MySQL,因為不支持異步調用,所以和 Tornado 不是很搭。不過性能其實很好,因此以后再去研究下其他方案吧……
裝好后就可以開始使用了:
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()
def on_finish(self):
self.session.close()
拿到 session 后,就可以執行 SQL 了:
于是來定義一個表:
BaseModel = declarative_base()
def init_db():
BaseModel.metadata.create_all(engine)
def drop_db():
BaseModel.metadata.drop_all(engine)
class User(BaseModel):
__tablename__ = 'user'
id = Column(Integer, primary_key=True)
name = Column(CHAR(30)) # or Column(String(30))
init_db()
declarative_base() 創建了一個 BaseModel 類,這個類的子類可以自動與一個表關聯。
以 User 類為例,它的 __tablename__ 屬性就是數據庫中該表的名稱,它有 id 和 name 這兩個字段,分別為整型和 30 個定長字符。Column 還有一些其他的參數,我就不解釋了。
最后,BaseModel.metadata.create_all(engine) 會找到 BaseModel 的所有子類,并在數據庫中建立這些表;drop_all() 則是刪除這些表。
接著就開始使用這個表吧:
user = User(name='a')
session.add(user)
user = User(name='b')
session.add(user)
user = User(name='a')
session.add(user)
user = User()
session.add(user)
session.commit()
query = session.query(User)
print query # 顯示SQL 語句
print query.statement # 同上
for user in query: # 遍歷時查詢
print user.name
print query.all() # 返回的是一個類似列表的對象
print query.first().name # 記錄不存在時,first() 會返回 None
# print query.one().name # 不存在,或有多行記錄時會拋出異常
print query.filter(User.id == 2).first().name
print query.get(2).name # 以主鍵獲取,等效于上句
print query.filter('id = 2').first().name # 支持字符串
query2 = session.query(User.name)
print query2.all() # 每行是個元組
print query2.limit(1).all() # 最多返回 1 條記錄
print query2.offset(1).all() # 從第 2 條記錄開始返回
print query2.order_by(User.name).all()
print query2.order_by('name').all()
print query2.order_by(User.name.desc()).all()
print query2.order_by('name desc').all()
print session.query(User.id).order_by(User.name.desc(), User.id).all()
print query2.filter(User.id == 1).scalar() # 如果有記錄,返回第一條記錄的第一個元素
print session.query('id').select_from(User).filter('id = 1').scalar()
print query2.filter(User.id > 1, User.name != 'a').scalar() # and
query3 = query2.filter(User.id > 1) # 多次拼接的 filter 也是 and
query3 = query3.filter(User.name != 'a')
print query3.scalar()
print query2.filter(or_(User.id == 1, User.id == 2)).all() # or
print query2.filter(User.id.in_((1, 2))).all() # in
query4 = session.query(User.id)
print query4.filter(User.name == None).scalar()
print query4.filter('name is null').scalar()
print query4.filter(not_(User.name == None)).all() # not
print query4.filter(User.name != None).all()
print query4.count()
print session.query(func.count('*')).select_from(User).scalar()
print session.query(func.count('1')).select_from(User).scalar()
print session.query(func.count(User.id)).scalar()
print session.query(func.count('*')).filter(User.id > 0).scalar() # filter() 中包含 User,因此不需要指定表
print session.query(func.count('*')).filter(User.name == 'a').limit(1).scalar() == 1 # 可以用 limit() 限制 count() 的返回數
print session.query(func.sum(User.id)).scalar()
print session.query(func.now()).scalar() # func 后可以跟任意函數名,只要該數據庫支持
print session.query(func.current_timestamp()).scalar()
print session.query(func.md5(User.name)).filter(User.id == 1).scalar()
query.filter(User.id == 1).update({User.name: 'c'})
user = query.get(1)
print user.name
user.name = 'd'
session.flush() # 寫數據庫,但并不提交
print query.get(1).name
session.delete(user)
session.flush()
print query.get(1)
session.rollback()
print query.get(1).name
query.filter(User.id == 1).delete()
session.commit()
print query.get(1)
下面開始介紹一些進階的知識。
如何批量插入大批數據?
可以使用非 ORM 的方式:
如何讓執行的 SQL 語句增加前綴?
使用 query 對象的 prefix_with() 方法:
如何替換一個已有主鍵的記錄?
使用 session.merge() 方法替代 session.add(),其實就是 SELECT + UPDATE:
如何使用無符號整數?
可以使用 MySQL 的方言:
id = Column(INTEGER(unsigned=True), primary_key=True)
模型的屬性名需要和表的字段名不一樣怎么辦?
開發時遇到過一個奇怪的需求,有個其他系統的表里包含了一個“from”字段,這在 Python 里是關鍵字,于是只能這樣處理了:
如何獲取字段的長度?
Column 會生成一個很復雜的對象,想獲取長度比較麻煩,這里以 User.name 為例:
如何指定使用 InnoDB,以及使用 UTF-8 編碼?
最簡單的方式就是修改數據庫的默認配置。如果非要在代碼里指定的話,可以這樣:
如何設置外鍵約束?
class User(BaseModel):
__tablename__ = 'user'
id = Column(Integer, primary_key=True)
age = Column(Integer)
class Friendship(BaseModel):
__tablename__ = 'friendship'
id = Column(Integer, primary_key=True)
user_id1 = Column(Integer, ForeignKey('user.id'))
user_id2 = Column(Integer, ForeignKey('user.id'))
for i in xrange(100):
session.add(User(age=randint(1, 100)))
session.flush() # 或 session.commit(),執行完后,user 對象的 id 屬性才可以訪問(因為 id 是自增的)
for i in xrange(100):
session.add(Friendship(user_id1=randint(1, 100), user_id2=randint(1, 100)))
session.commit()
session.query(User).filter(User.age < 50).delete()
執行這段代碼時,你應該會遇到一個錯誤:
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'))
如何連接表?
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,使用左連接)
為什么無法刪除 in 操作查詢出來的記錄?
如何擴充模型的基類?
declarative_base() 會生成一個 class 對象,這個對象的子類一般都和一張表對應。如果想增加這個基類的方法或屬性,讓子類都能使用,可以有三種方法:
1.定義一個新類,將它的方法設置為基類的方法:
@classmethod
def get_all(cls, session, columns=None, offset=None, limit=None, order_by=None, lock_mode=None):
if columns:
if isinstance(columns, (tuple, list)):
query = session.query(*columns)
else:
query = session.query(columns)
if isinstance(columns, str):
query = query.select_from(cls)
else:
query = session.query(cls)
if order_by is not None:
if isinstance(order_by, (tuple, list)):
query = query.order_by(*order_by)
else:
query = query.order_by(order_by)
if offset:
query = query.offset(offset)
if limit:
query = query.limit(limit)
if lock_mode:
query = query.with_lockmode(lock_mode)
return query.all()
BaseModel.get_all = get_all
@classmethod
def count_all(cls, session, lock_mode=None):
query = session.query(func.count('*')).select_from(cls)
if lock_mode:
query = query.with_lockmode(lock_mode)
return query.scalar()
BaseModel.count_all = count_all
@classmethod
def exist(cls, session, id, lock_mode=None):
if hasattr(cls, 'id'):
query = session.query(func.count('*')).select_from(cls).filter(cls.id == id)
if lock_mode:
query = query.with_lockmode(lock_mode)
return query.scalar() > 0
return False
BaseModel.exist = exist
@classmethod
def set_attr(cls, session, id, attr, value):
if hasattr(cls, 'id'):
session.query(cls).filter(cls.id == id).update({
attr: value
})
session.commit()
BaseModel.set_attr = set_attr
@classmethod
def set_attrs(cls, session, id, attrs):
if hasattr(cls, 'id'):
session.query(cls).filter(cls.id == id).update(attrs)
session.commit()
BaseModel.set_attrs = set_attrs
如何正確使用事務?
假設有一個簡單的銀行系統,一共兩名用戶:
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()
user1 = session1.query(User).get(1)
user2 = session1.query(User).get(2)
if user1.money >= 100:
user1.money -= 100
user2.money += 100
session1.add(TanseferLog(from_user=1, to_user=2, amount=100))
user1 = session2.query(User).get(1)
user2 = session2.query(User).get(2)
if user1.money >= 100:
user1.money -= 100
user2.money += 100
session2.add(TanseferLog(from_user=1, to_user=2, amount=100))
session1.commit()
session2.commit()
可見 MySQL InnoDB 雖然支持事務,但并不是那么簡單的,還需要手動加鎖。
首先來試試讀鎖:
user1 = session2.query(User).with_lockmode('read').get(1)
user2 = session2.query(User).with_lockmode('read').get(2)
if user1.money >= 100:
user1.money -= 100
user2.money += 100
session2.add(TanseferLog(from_user=1, to_user=2, amount=100))
session1.commit()
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 記錄。等我查詢完兩張表,釋放了讀鎖后,轉賬就可以繼續進行了,不過我顯示的數據在當時的確是正確和一致的。
另外要注意的是,如果被查詢的字段沒有加索引的話,就會變成鎖整張表了:
session1.rollback()
session2.rollback()
session1.query(User).filter(User.money == 50).with_lockmode('update').all()
session2.query(User).filter(User.money == 40).with_lockmode('update').all() # 會等待解鎖,因為 money 上沒有索引
另一個注意點是子事務。
InnoDB 支持子事務(savepoint 語句),可以簡化一些邏輯。
例如有的方法是用于改寫數據庫的,它執行時可能提交了事務,但在后續的流程中卻執行失敗了,卻沒法回滾那個方法中已經提交的事務。這時就可以把那個方法當成子事務來運行了:
def step2():
# ...
if success:
session.commit()
return True
session.rollback()
return False
session.begin_nested()
if step1():
session.begin_nested()
if step2():
session.commit()
else:
session.rollback()
else:
session.rollback()
如何對一個字段進行自增操作?
最簡單的辦法就是獲取時加上寫鎖:
新聞熱點
疑難解答
圖片精選