目錄

前文列表

擴充套件閱讀

SQLAlchemy 的 CRUD

CRUD 提供了在 Web 應用程式中所需要的所有操作和檢視資料的基礎功能, 尤其在 REST 風格的應用中, CRUD 就能實現一切所需功能.

本篇博文主要記錄 SQLAlchemy 實現 CRUD 的語句, 依然是在 manager shell 中完成:

(blog)fanguiju@fanguiju:/opt/JmilkFan-s-Blog$ python manage.py shell
>>> app
<Flask 'main'>
>>> User
 

<class 'models.User'>
>>> db
<SQLAlchemy engine='mysql+pymysql://root:[email protected]:3306/myblog?charset=utf8'>

為了讓在 manager shell 中的執行效果更直觀一些, 首先, 先對 User models 做一些修改:

from flask.ext.sqlalchemy import SQLAlchemy
from main import app


# INIT the sqlalchemy object
# Will be load the SQLALCHEMY_DATABASE_URL from config.py
 

db = SQLAlchemy(app)


class User(db.Model):
    """Represents Proected users."""

    # Set the name for table
    __tablename__ = 'users'
    id = db.Column(db.String(45), primary_key=True)
    username = db.Column(db.String(255))
    password = db.Column(db.String(255))

    def __init__(self, id, username, password)
 
:
        self.id = id
        self.username = username
        self.password = password

    def __repr__(self):
        """Define the string format for instance of User."""
        return "<Model User `{}`>".format(self.username)

Create 增添資料

為新建的 User models 新增一條記錄的操作看起來跟 Git 的提交操作非常類似, 其包含的意義也大致相同, 是為了儘量減少不必要的 I/O 操作:

• add: 把資料新增到會話物件中 (資料狀態為待儲存)
• commit: 將會話物件中的資料提交 (資料被寫入資料庫中)

>>> from uuid import uuid4
>>> user = User(id=str(uuid4()), username='jmilkfan', password='fanguiju')
>>> db.session.add(user)
>>> db.session.commit()

然後再檢視一下資料庫, 檢驗是否生效:

mysql> select * from users;
+--------------------------------------+----------+----------+
| id                                   | username | password |
+--------------------------------------+----------+----------+
| d2c3a206-c4d4-4ce9-91f1-ed4bbbb28c76 | jmilkfan | fanguiju |
+--------------------------------------+----------+----------+
1 row in set (0.00 sec)

從這個例子可以看出, 一個 class User 的例項化物件就是一條包含了欄位值的記錄物件, 將該記錄物件新增並提交到 session , 就會把記錄物件的資料寫入到資料庫中.

Retrieve 讀取資料

把資料新增僅資料庫表後, SQLAlchemy 可以通過 Model.query 方法對資料進行查詢. Model.query == db.session.query(Model) 兩種寫法是等效的. 區別在於前者使用的是 flask_sqlalchemy.BaseQuery object, 後者使用的是 sqlalchemy.orm.query.Query object . 但兩者本質上都是一個 Query 物件.

讀取資料有兩種情況:

• 讀取一條資料: 需要指定唯一的過濾條件來獲取, 一般會使用主鍵作為過濾條件.

>>> user = User.query.first()
>>> user.username
u'fanguiju'
# 返回表中的第一條記錄
# 其中 User.query 返回的是 flask_sqlalchemy.BaseQuery object
# flask_sqlalchemy.BaseQuery object 擁有對資料庫操作的所有抽像方法

# or

>>> user = User.query.get('49f86ede-f1e5-410e-b564-27a97e12560c')
>>> user
<Model User `fanguiju`>
# 返回表中指定主鍵的一條記錄

# or

>>> user = db.session.query(User).filter_by(id='49f86ede-f1e5-410e-b564-27a97e12560c').first()
>>> user
<Model User `fanguiju`>
# 返回符合過濾條件的第一條記錄
# 其中 db.session.query(User).filter_by(id='49f86ede-f1e5-410e-b564-27a97e12560c') 返回的是一個 sqlalchemy.orm.query.Query object 物件
# sqlalchemy.orm.query.Query.first() 才是一個 User 物件

• 讀取多條資料: 指定任意條件作為過濾條件或者不過濾的獲取全部資料

# 獲取多條記錄
>>> user = db.session.query(User).filter_by(username='fanguiju').all()
>>> user
[<Model User `fanguiju`>]
# 返回符合過濾條件的所有記錄, 將所有 username == fanguiju 的記錄都獲取

# 獲取全部資料
>>> users = User.query.all()
>>> users
[<Model User `fanguiju`>, <Model User `jmilkfan`>]
# or
>>> db.session.query(User).all()
[<Model User `fanguiju`>, <Model User `jmilkfan`>]

NOTE: 因為在 Flask 中的 SQLAlchemy 擁有 flask-sqlalchemy 和 sqlalchemy.orm 兩種語法, 為了避免看花眼的情況, 以後的程式碼中只會使用通用性更強一些的 sqlalchemy.orm 的語法.

除了上述兩種操作之外, 還有非常之多不同花樣的資料讀取方式, 讀取資料是 4 種操作型別中最複雜多樣的一中操作型別.

限制返回記錄的數目

這個返回特徵常與資料的分頁功能結合使用.

>>> users = db.session.query(User).limit(10).all()

返回記錄的排序

SQLAlchemy 預設會根據主鍵的順序來排序, 也是要顯示的使用 order_by 函式來指定排序條件和排序的方式:

# 正向排序
>>> users = db.session.query(User).order_by(User.username).all()
>>> users
[<Model User `fanguiju`>, <Model User `jmilkfan`>]

# 反向排序
>>> users = db.session.query(User).order_by(User.username.desc()).all()
>>> users
[<Model User `jmilkfan`>, <Model User `fanguiju`>]


>>> users = db.session.query(User).order_by(User.password).all()
>>> users
[<Model User `jmilkfan`>, <Model User `fanguiju`>]

查詢函式的鏈式呼叫

Query 物件提供了非常多且靈活的資料庫操作抽象方法, 我們可以鏈式的去組合這些方法來達到希望的效果. 但需要注意的是, 刪除操作的鏈式呼叫一定要謹慎而為.

>>> users = db.session.query(User).order_by(User.username).limit(10).all()

可以使用 dir() 內建函式來檢視一個 Query 物件提供的方法列表.

dir(db.session.query(User))

NOTE: 一條讀取語句的鏈式操作都是一個 first() 或 all() 函式結束的. 它們會終止鏈式呼叫並返回結果.

Flask-SQLAlchemy 的專有分頁函式 pagination

pagination(): 是專門設計來實現分頁功能的函式, 所以必須由 flask_sqlalchemy.BaseQuery object 來呼叫.

>>> db.session.query(User).paginate(1,1)
Traceback (most recent call last):
  File "<console>", line 1, in <module>
AttributeError: 'Query' object has no attribute 'paginate'

• 第一個引數表示查詢返回第幾頁的內容
• 第二個引數表示每頁顯示的物件數量

>>> User.query.paginate(1,10)     # 查詢第 1 頁,且 1 頁顯示 10 條內容
<flask_sqlalchemy.Pagination object at 0x7f214419fe50>

paginate() 與 first()/all() 不同, 後者返回的是一個 models 物件或 models 物件列表, 而前者返回的是一個 pagination 物件. 而且 pagination 物件還包含了幾個特有的屬性:

>>> user_page = User.query.paginate(1, 10)

# 獲取這一頁所包含的資料物件
>>> user_page.items
[<Model User `fanguiju`>, <Model User `jmilkfan`>]

# 獲取這一頁的頁碼
>>> user_page.page
1

# 獲取總共的頁數
>>> user_page.pages
1

# 是否有上一頁
>>> user_page.has_prev
False

# 如果有上一頁的話, 獲取上一頁的 pagination 物件
>>> if user_page.has_prev:
...     user_page.prev()
... 

# 是否有下一頁
>>> user_page.has_next
False

# 如果有下一頁的話, 獲取下一個的 pagination 物件
>>> if user_page.has_next:
...     user_page.next()
... 

Query 的過濾器

在查詢資料時, 可以根據一定的條件集合來獲得過濾後的資料. SQLAlchemy 提供了過濾器 query.filter_by() 和 query.filter(), 過濾器接受的引數就是過濾條件, 有下面幾種形式:

• 欄位鍵值對, EG. username='fanguiju'
• 比較表示式, EG. User.id > 100
• 邏輯函式, EG. in_/not_/or_

EXAMPLE:

>>> user = db.session.query(User).filter(User.username.in_(['fanguiju', 'jmilkfan'])).limit(1).all()   # 當然也可以結合鏈式函式來使用
>>> user
[<Model User `fanguiju`>]

>>> user = db.session.query(User).filter(not_(User.password == None)).all()
>>> user
[<Model User `fanguiju`>, <Model User `jmilkfan`>]

>>> user = db.session.query(User).filter(or_(not_(User.username == None), User.password != None)).all()
>>> user
[<Model User `fanguiju`>, <Model User `jmilkfan`>]

可以將 query.filter() 內建的邏輯函式 in_/not_/or_ 結合使用來實現更復雜的過濾.

Update 更新資料

>>> user = db.session.query(User).first()
>>> user.username
u'fanguiju'

>>> user = db.session.query(User).update({'username': 'update_fanguiju'})
>>> db.session.commit()

>>> user = db.session.query(User).first()
>>> user.username
u'update_fanguiju'

如上述例子, 先定位到你希望更新的記錄, 然後通過 Query 物件的 update() 傳遞要更新內容. 注意: 更新的內容必須是 Dict 資料型別.

需要注意的是: 就如使用原生 SQL 指令來更新記錄一樣, 如果沒有指定要更新具體的哪一條記錄的話, 會將該欄位所在列的所有記錄值一同更新, 所以切記使用過濾條件來定位到具體需要更新的記錄.

而且 update() 會自動的新增 User 的例項化物件到 session 中, 所以直接 commit 就可以寫入到資料庫了.

Delete 刪除資料

>>> user = db.session.query(User).first()
>>> user
<Model User `update_fanguiju`>

>>> db.session.delete(user)
>>> db.session.commit()

將查詢返回的 User 例項化物件進行 session 的 delete 操作, 就能夠刪除該物件所對映的記錄資料了.