Try   HackMD

Flask Extension(02)_Flask-SQLAlchemy(2)

tags: book flask flask 2.x flask extension sqlalchemy python

Flask-SQLAlchemy
SQLAlchemy

我們已經成功利用model生成table,以系統面來看,CRUD是系統對資料庫會有的四種基礎操作,我們就在這邊演練一番。

操作model

sqlalchemy在經過改版之後的資料查詢方式已經跟之前不一樣了,相對應的,flask-sqlalchemy也跟著變化,如果你想執行查詢,請使用表達式db.session.execute(db.select(Model).order_by(Model.prop)).scalars()或是db.session.execute(db.select(Model).order_by(Model.prop)).scalar()

Notes:

相關資料查詢的部份可以參考sqlalchemy說明

如果是scalars的話,得到的資料會是一個ScalarResult的物件,不過我們現在的資料表並沒有任何的資料存在,所以要來寫入一筆:

user = User(username='shaoe.chen', email='shaoe.chen@email.com') with app.app_context(): db.session.add(user) db.session.commit()

我們使用ORM的方式,基本上就是new一個model,然後給定欄位值,因為我們是測試,這個操作必需是在flask的context中執行,所以就用with app.app_context(),裡面最重要的當然就是db.sessiondb.session.add意謂著我們把這個資料寫入資料庫,而db.session.commit()則是完成這筆交易記錄,不是那麼建議設置auto commit就是了。


當然,我們可以使用一些工具來檢查資料是否確實的寫入資料庫。

接下來我們就可以嚐試來做查詢,一樣的,利用上面所說的表達式,做一次驗證確認:

user = None with app.app_context(): user = db.session.execute(db.select(User).order_by(User.id)).scalar()

下面給出結果:

user <User 1>

很明顯的就是,如果是scalar()的話,得到的會是單筆的記錄,直接就是User這個物件。

接下來,我們來看一下怎麼處理另一個scalars()

user = None with app.app_context(): user = db.session.execute(db.select(User).order_by(User.id)).scalars().fetchall()

作法上比較不一樣是因為,利用scalars取回的資料是一個ScalarResult的物件,接續的就是看你要怎麼去操作它。fetchall()就是將所有的資料一次取回,這時候得到的就會是一個list:

user [<User 1>]

Notes:

非常建議你自己手動再補一筆資料進去,然後再執行一次查詢看看結果。

flask-sqlalchemy有一個更為漂亮的方法,也就是get_or_404

user = None with app.app_context(): user = db.get_or_404(User, 1)

只是說,如果你使用這個函數的話就要注意一下,沒資料它就拋出404,記得做好404的處理就好。這後續實作過程中就會有說明了。

最後再來快速的說說更新跟刪除的方式,如果是刪除的話就利用db.session.delete,這很直觀,如果是更新的話就把model當做物件一般的操作即可,最後記得加上db.session.commit

user.username='ShaoeChen' with app.app_context(): db.session.add(user) db.session.commit()

雖然官方文件上寫的說明是只要修正屬性之後直接完成這筆交易記錄就好,但是我實測還是要再經過db.session.add才能成功寫入。

Notes:

  • 說明過程中會加入with app.app_context()是因為,根據官方文件的quickstart中所寫,『You must be in an active Flask application context to execute queries and to access the session and engine.』。
  • 更多資料操作的部份請參考Modifying and Querying Data

結論

我的資料操作都是在pycharm的cmd上執行的,所以每次的操作都需要加入with app.app_context,這是因為flask-sqlalchemy的db.session只能在flask的上下文中執行,也就是說,等我們進入正式開發的時候就不用再這麼麻煩了。

簡單的範例應該都可以知道ORM的便利性了,但是,這是對一張table的操作,關聯式資料庫,想當然就是會有很多張table互相有關聯,後續就要來瞭解如何設置table之間的關聯對應。楊千老師說,一天不要學太多東西,每天都要學一點,所以就此打住,不急。