使用Flask-SQLAlchemy插件進行數據庫操作

依照慣例,本文開頭先提供Flask-SQLAlchemy的官方文檔地址

Flask框架之所以強大有一個重要因素是良好的生態系統支持用戶對原框架進行擴展,Flask-SQLAlchemy就是一個擴展插件,其作用是幫助用戶操作數據庫(增、刪、改、查、創表、提交事務等等),或者說這是一個ORM插件(O-ObjectR-RelationalM-Mapping,簡言之就是用對象去表達數據結構的插件)。顯然,使用Flask-SQLAlchemy最大的好處就是操作不同的數據庫時不必關注數據庫特異性,一套代碼重復利用。

使用Flask-SQLAlchemy

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
db = SQLAlchemy(app)

引入flask_sqlalchemy插件,調用SQLAlchemyflask app綁定

調用SQLAlchemy是因為這是flask_sqlalchemy提供的一個__init__函數,源碼:

#: 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:通過看源碼應該能發現調用SQLAlchemyapp是可以不用傳入的,可以初始化時再調用init_app傳入app,這特別適用于工廠函數創建app的情況

使用Flask-SQLAlchemy創建表

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

核心是創建一個類繼承Model屬性(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
    
    這兩行是python對象的__repr__方法,重寫是為了方便程序員查看對象,不屬于flask-sqlalchemy提供的特殊內容

當然,這是最簡單的數據表,實際操作中肯定會涉及到數據表的互相關聯。這一部分實際是數據庫的基礎知識而不是Flask-SQLAlchemy的獨特內容。簡單提一下Flask-SQLAlchemy是有APIForeignKeyrelationship幫助我們創表時關聯數據表的。具體內容可以查看上面的官方文檔。

使用Flask-SQLAlchemy進行增、刪、改、查

做數據庫基本操作必然涉及到數據庫事務,這里先說如何使用SQLAlchemy提交事務

db.session.add(xxx)
db.session.delete(xxx)
db.session.commit()

session API中帶有adddelete等方法,直接調用即可,最后再commit。當然,如同寫SQL語句一樣,針對不同的操作還有更多API,例如session.add_all()session.rollback()等等,這里不詳述了。

前面說了相關的API,現在總結一下增、刪、改、查具體操作。

from yourapp import User
me = User('admin', 'admin@example.com')
db.session.add(me)
db.session.commit()

以添加一條記錄為例,所有的執行都是遵循三個步驟

  • 創建一個python對象(這個對象是相應數據表類的一個實例,也就是相應數據表的一條記錄)
  • 調用session中的API
  • 提交事務
db.session.delete(me)
db.session.commit()

刪除一條記錄也是類似的

admin = Role.query.filter_by(name='Admin').first()

查詢表中某條記錄可以直接調用對象的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進行數據庫基本操作已經都介紹完了,復雜的用法請查看開頭的官方文檔。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,488評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,034評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,327評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,554評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,337評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,883評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,975評論 3 439
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,114評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,625評論 1 332
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,555評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,737評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,244評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,973評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,362評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,615評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,343評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,699評論 2 370