依照慣例,本文開頭先提供Flask-SQLAlchemy的官方文檔地址
Flask
框架之所以強大有一個重要因素是良好的生態(tài)系統(tǒng)支持用戶對原框架進行擴展庆揪,Flask-SQLAlchemy
就是一個擴展插件届囚,其作用是幫助用戶操作數(shù)據(jù)庫(增艘包、刪、改柒巫、查颓帝、創(chuàng)表米碰、提交事務(wù)等等),或者說這是一個ORM
插件(O
-Object
躲履、R
-Relational
见间、M
-Mapping
,簡言之就是用對象去表達數(shù)據(jù)結(jié)構(gòu)的插件)工猜。顯然米诉,使用Flask-SQLAlchemy
最大的好處就是操作不同的數(shù)據(jù)庫時不必關(guān)注數(shù)據(jù)庫特異性,一套代碼重復利用篷帅。
使用Flask-SQLAlchemy
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
app = Flask(__name__)
db = SQLAlchemy(app)
引入flask_sqlalchemy
插件史侣,調(diào)用SQLAlchemy
和flask app
綁定
調(diào)用
SQLAlchemy
是因為這是flask_sqlalchemy
提供的一個__init__
函數(shù),源碼:#: Default query class used by :attr:`Model.query` and other queries. #: Customize this by passing ``query_class`` to :func:`SQLAlchemy`. #: Defaults to :class:`BaseQuery`. Query = None def __init__(self, app=None, use_native_unicode=True, session_options=None, metadata=None, query_class=BaseQuery, model_class=Model): self.use_native_unicode = use_native_unicode self.Query = query_class self.session = self.create_scoped_session(session_options) self.Model = self.make_declarative_base(model_class, metadata) self._engine_lock = Lock() self.app = app _include_sqlalchemy(self, query_class) if app is not None: self.init_app(app)
PS:通過看源碼應(yīng)該能發(fā)現(xiàn)調(diào)用
SQLAlchemy
時app
是可以不用傳入的魏身,可以初始化時再調(diào)用init_app
傳入app
惊橱,這特別適用于工廠函數(shù)創(chuàng)建app
的情況
使用Flask-SQLAlchemy
創(chuàng)建表
class User(db.Model):
__tablename__ = 'users'
id = db.Column(db.Integer, primary_key=True)
username = db.Column(db.String(80), unique=True, nullable=False)
email = db.Column(db.String(120), unique=True, nullable=False)
def __repr__(self):
return '<User %r>' % self.username
核心是創(chuàng)建一個類繼承Model
屬性(Model
屬性是啥,可以按照上面的源碼去查看)
這里講一下代碼含義:
-
__tablename__ = 'users'
是給表命名(這句也可以省略箭昵,但是一般表名還是推薦自己人捌印) -
這部分是添加表的字段,以及相應(yīng)字段的屬性id = db.Column(db.Integer, primary_key=True) username = db.Column(db.String(80), unique=True, nullable=False) email = db.Column(db.String(120), unique=True, nullable=False)
-
這兩行是def __repr__(self): return '<User %r>' % self.username
python
對象的__repr__
方法家制,重寫是為了方便程序員查看對象正林,不屬于flask-sqlalchemy
提供的特殊內(nèi)容
當然,這是最簡單的數(shù)據(jù)表颤殴,實際操作中肯定會涉及到數(shù)據(jù)表的互相關(guān)聯(lián)觅廓。這一部分實際是數(shù)據(jù)庫的基礎(chǔ)知識而不是Flask-SQLAlchemy
的獨特內(nèi)容。簡單提一下Flask-SQLAlchemy
是有APIForeignKey
涵但、relationship
幫助我們創(chuàng)表時關(guān)聯(lián)數(shù)據(jù)表的杈绸。具體內(nèi)容可以查看上面的官方文檔。
使用Flask-SQLAlchemy
進行增矮瘟、刪瞳脓、改、查
做數(shù)據(jù)庫基本操作必然涉及到數(shù)據(jù)庫事務(wù)澈侠,這里先說如何使用SQLAlchemy
提交事務(wù)
db.session.add(xxx)
db.session.delete(xxx)
db.session.commit()
session
API中帶有add
劫侧、delete
等方法,直接調(diào)用即可埋涧,最后再commit
板辽。當然,如同寫SQL
語句一樣棘催,針對不同的操作還有更多API劲弦,例如session.add_all()
、session.rollback()
等等醇坝,這里不詳述了邑跪。
前面說了相關(guān)的API,現(xiàn)在總結(jié)一下增呼猪、刪画畅、改、查具體操作宋距。
from yourapp import User
me = User('admin', 'admin@example.com')
db.session.add(me)
db.session.commit()
以添加一條記錄為例轴踱,所有的執(zhí)行都是遵循三個步驟
- 創(chuàng)建一個python對象(這個對象是相應(yīng)數(shù)據(jù)表類的一個實例,也就是相應(yīng)數(shù)據(jù)表的一條記錄)
- 調(diào)用
session
中的API - 提交事務(wù)
db.session.delete(me)
db.session.commit()
刪除一條記錄也是類似的
admin = Role.query.filter_by(name='Admin').first()
查詢表中某條記錄可以直接調(diào)用對象的query
方法谚赎,相當于SELECT
語句
admin = Role.query.filter_by(name='Admin').first()
if admin is not None:
admin.name = 'admin'
db.session.add(admin)
db.session.commit()
修改記錄可以綜合查找和添加兩步:
- 查出記錄
- 修改
- 提交
至此淫僻,使用Flask-SQLALchemy
進行數(shù)據(jù)庫基本操作已經(jīng)都介紹完了,復雜的用法請查看開頭的官方文檔壶唤。