SQLAlchemy - filter vs filter_by

SQLAlchemy ORM Query API 提供 filter(*criterion) 與 filter_by(**kwargs) 2 種 Query 方式，都是分別對應到 SQL 中的 WHERE 語句，不過用法上有些許出入。

特此筆記一篇。

filter_by(**kwargs) #

filter_by(**kwargs) 用法是 keyword expression 的方式設定 Query 條件，可接受的 keywords 為 Model 的欄位名稱，多個 keyword expression 會用 SQL 的 AND 串連起來，無法選擇使用 OR 對資料表(table)進行篩選。

Multiple criteria may be specified as comma separated; the effect is that they will be joined together using the and_() function

例如以下 Model:

from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker
from sqlalchemy import Column, String, Integer
from sqlalchemy.ext.declarative import declarative_base


Base = declarative_base()
class User(Base):
    __tablename__ = 'user'
    id = Column(Integer, primary_key=True)
    name = Column(String)
    username = Column(String)
    password = Column(String)


engine = create_engine('sqlite:///:memory:', echo=True)
Base.metadata.create_all(engine)
Session = sessionmaker(bind=engine)
session = Session()

如果要用 filter_by(**kwargs) 篩選 name 是 Jake 且 username 也為 jake 的使用者：

users = session.query(User).filter_by(name='Jake', username='Jake').all()

如果各種條件間要用 AND 串連，而且 Query 條件很單純(例如都是 where column = value )的話就可以直接使用 filter_by(**kwargs) 。

filter(*criterion) #

相對於單純的 filter_by(**kwargs) , filter(*criterion) 則提供更彈性與多元的 Query 用法，例如 SQL 語法中的 WHERE column != value , WHERE column >= value 以及 WHERE column in (...) 等等，而且能夠選擇 AND 與 OR 的方式串連篩選資料表的條件，在不明確指定以 AND 或 OR 串連條件時，預設以 AND 進行條件串連。

不過在篩選條件的設定上，就得明確寫出 model 名稱與欄位名稱。

同樣以 User model 為例，示範各種用法：

篩選 username 為 Jake 或 Jason ，或者 name 為 Jake 或 Jason :

users = session.query(User).filter(
	or_(
		User.username.in_(['Jake', 'Jason']),
		User.name.in_(['Jake', 'Jason'])
	)
).all()

上述範例可以發現每個 ORM model 的欄位都有提供 in_ 方法，讓我們使用 SQL 中 IN (...) 的語法。

篩選 id 大於 1000 且 name 為 Jerry 的資料：

users = session.query(User).filter(
	User.id > 1000,
	User.name == 'Jerry',
).all()

上述範例可以發現 ORM model 使用 filter(*criterion) 時，是用 > == >= <= < != 等比較運算元(comparison operator)設定篩選條件，與 filter_by(**kwargs) 不同。

篩選 password 是 NULL 的資料：

users = session.query(User).filter(User.password == None).all()

由於 filter(*criterion) 時，是用 > == >= <= < != 等比較運算元(comparison operator)設定篩選條件，所以篩選 NULL 的條件時會變成 == None ，這也經常會導致 Python Linter 的警告，因此可以用 is_(other) 方法進一步改為：

users = session.query(User).filter(User.password.is_(None)).all()

如此一來 Linter 就不會警告了！

References #

https://docs.sqlalchemy.org/en/latest/orm/query.html#sqlalchemy.orm.query.Query