SQLAlchemy ORM IN / NOT IN 範例

SQLAlchemy 是 Python 生態系中相當成熟的 ORM(Object Relational Mapper) 套件，不過也因為支援相當多功能，所以經常要翻閱文件查詢 SQL 中相應的功能要如何撰寫。

本篇紀錄如何使用 SQLAlchemy 撰寫含有 IN 與 NOT IN 語句的 ORM.

本文環境 #

• Python 3.6.5
• SQLAlchemy 1.2.7

範例 #

首先同樣定義 1 個簡單的 ORM 作為練習，以下範例定義一個 User 的 ORM：

from sqlalchemy import create_engine
from sqlalchemy import Column, String, Integer
from sqlalchemy.orm import sessionmaker
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() 

IN #

in 的用法如下，可以看到直接在 column 屬性上加上 .in_() 即可(p.s. in_() 只接受 iterable 的資料型別）：

session.query(User).filter(
	User.id.in_([1, 2, 3])
).all()

正確執行的話，可以看到 SQLAlchemy 會印出類似以下的訊息，可以看到 SQL 語句中多了 IN ：

2019-03-24 10:47:39,302 INFO sqlalchemy.engine.base.Engine SELECT user.id AS user_id, user.name AS user_name, user.username AS user_username, user.password AS user_password 
FROM user 
WHERE user.id IN (?, ?, ?)
2019-03-24 10:47:39,303 INFO sqlalchemy.engine.base.Engine (1, 2, 3)

NOT IN #

not in 的用法如下，與 .in_() 相似，只要改成 .notin_() 即可：

session.query(User).filter(
	User.id.notin_([1, 2, 3])
).all()

正確執行的話，可以看到 SQLAlchemy 會印出類似以下的訊息，可以看到 SQL 語句中多了 NOT IN ：

2019-03-24 11:02:58,113 INFO sqlalchemy.engine.base.Engine SELECT user.id AS user_id, user.name AS user_name, user.username AS user_username, user.password AS user_password 
FROM user 
WHERE user.id NOT IN (?, ?, ?)
2019-03-24 11:02:58,115 INFO sqlalchemy.engine.base.Engine (1, 2, 3)

除了 .notin_() 的用法之外，還可以直接改成用 ~ 加上 .in_() 達到相同目的：

p.s. ~ 在 SQLAlchemy 中稱為 negation, 指的是相反的意思，所以 ~ 加上 .in_() 就等於 .notin_()

session.query(User).filter(
	~User.id.in_([1, 2, 3])
).all()

2019-03-24 11:05:18,203 INFO sqlalchemy.engine.base.Engine SELECT user.id AS user_id, user.name AS user_name, user.username AS user_username, user.password AS user_password 
FROM user 
WHERE user.id NOT IN (?, ?, ?)
2019-03-24 11:05:18,204 INFO sqlalchemy.engine.base.Engine (1, 2, 3)

補充 #

事實上， in 與 not in 等常用 SQL 語句的功能， SQLAlchemy 實作於 sqlalchemy.orm.properties.ColumnProperty.Comparator 類別中， SQLAlchemy ORM 類別中的每個 Column 都可以取得該類別的方法使用。

所以當我們需要在 WHERE 語句內加上用以比較(compare)或者過濾(filter)的條件時，就不妨翻看看 sqlalchemy.orm.properties.ColumnProperty.Comparator 吧，相信一定有你需要的功能！

References #

https://docs.sqlalchemy.org/en/latest/orm/internals.html#sqlalchemy.orm.properties.ColumnProperty.Comparator