sqlalchemy 动态过滤

Question

我正在尝试使用 SQLAlchemy ORM 实现动态过滤。

我正在查看 StackOverflow 并发现非常相似的问题：SQLALchemy dynamic filter_by

对我有用，但还不够。

所以，这里有一些代码示例，我正在尝试编写：

# engine - MySQL engine
session_maker = sessionmaker(bind=engine)
session = session_maker()

# my custom model
model = User

def get_query(session, filters):
    if type(filters) == tuple:
        query = session.query(model).filter(*filters)
    elif type(filters) == dict:
        query = session.query(model).filter(**filters)
    return query

然后我试图用非常相似的东西重用它：

filters = (User.name == 'Johny')
get_query(s, filters) # it works just fine

filters = {'name': 'Johny'}
get_query(s, filters)

第二次运行后，出现了一些问题：

TypeError: filter() got an unexpected keyword argument 'name'

当我尝试将我的 filters 更改为：

filters = {User.name: 'Johny'}

它返回：

TypeError: filter() keywords must be strings

但它适用于手动查询：

s.query(User).filter(User.name == 'Johny')

我的过滤器有什么问题？

顺便说一句，看起来它适用于案例：

filters = {'name':'Johny'}
s.query(User).filter_by(**filters)

但根据上述帖子的建议，我尝试仅使用 filter。

如果只能使用filter_by而不是filter，这两种方法有什么区别吗？

Answer 1

您的问题是 filter_by 接受关键字参数，但 filter 接受表达式。因此，扩展 filter_by **mydict 的字典将起作用。使用过滤器，您通常会传递一个参数，它恰好是一个表达式。因此，当您将 **filters 字典扩展为过滤器时，您会传递过滤器一堆它不理解的关键字参数。

如果您想从存储的过滤器参数的字典中构建一组过滤器，您可以使用查询的生成特性来继续应用过滤器。例如：

# assuming a model class, User, with attributes, name_last, name_first
my_filters = {'name_last':'Duncan', 'name_first':'Iain'}
query = session.query(User)
for attr,value in my_filters.iteritems():
    query = query.filter( getattr(User,attr)==value )
# now we can run the query
results = query.all()

上述模式的好处是你可以在多个连接列中使用它，你可以用and_和or_构造'ands'和'ors'，你可以做

Answer 2

我有类似的问题，尝试从字典中过滤：

filters = {"field": "value"}

错误：

...query(MyModel).filter(**filters).all()

好：

...query(MyModel).filter_by(**filters).all()

Answer 3

FWIW，有一个 Python 库旨在解决这个确切的问题：sqlalchemy-filters

它允许使用所有运算符动态过滤，而不仅仅是==。

from sqlalchemy_filters import apply_filters


# `query` should be a SQLAlchemy query object

filter_spec = [{'field': 'name', 'op': '==', 'value': 'name_1'}]
filtered_query = apply_filters(query, filter_spec)

more_filters = [{'field': 'foo_id', 'op': 'is_not_null'}]
filtered_query = apply_filters(filtered_query, more_filters)

result = filtered_query.all()

Answer 4

class Place(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    search_id = db.Column(db.Integer, db.ForeignKey('search.id'), nullable=False)

    @classmethod
    def dynamic_filter(model_class, filter_condition):
        '''
        Return filtered queryset based on condition.
        :param query: takes query
        :param filter_condition: Its a list, ie: [(key,operator,value)]
        operator list:
            eq for ==
            lt for <
            ge for >=
            in for in_
            like for like
            value could be list or a string
        :return: queryset
        '''
        __query = db.session.query(model_class)
        for raw in filter_condition:
            try:
                key, op, value = raw
            except ValueError:
                raise Exception('Invalid filter: %s' % raw)
            column = getattr(model_class, key, None)
            if not column:
                raise Exception('Invalid filter column: %s' % key)
            if op == 'in':
                if isinstance(value, list):
                    filt = column.in_(value)
                else:
                    filt = column.in_(value.split(','))
            else:
                try:
                    attr = list(filter(lambda e: hasattr(column, e % op), ['%s', '%s_', '__%s__']))[0] % op
                except IndexError:
                    raise Exception('Invalid filter operator: %s' % op)
                if value == 'null':
                    value = None
                filt = getattr(column, attr)(value)
            __query = __query.filter(filt)
        return __query

执行如下：

places = Place.dynamic_filter([('search_id', 'eq', 1)]).all()

Answer 5

对于使用 FastAPI 和 SQLAlchemy 的人来说，这里是一个动态过滤的例子：

api/app/app/crud/order.py

from typing import Optional

from pydantic import UUID4
from sqlalchemy.orm import Session

from app.crud.base import CRUDBase
from app.models.order import Order
from app.schemas.order import OrderCreate, OrderUpdate


class CRUDOrder(CRUDBase[Order, OrderCreate, OrderUpdate]):

    def get_orders(
        self,
        db: Session,
        owner_id: UUID4,
        status: str,
        trading_type: str,
        pair: str,
        skip: int = 0,
        limit: int = 100,
    ) -> Optional[Order]:
        filters = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and arg != "db" and arg != "skip" and arg != "limit" and value is not None
        }
        query = db.query(self.model)
        for attr, value in filters.items():
            query = query.filter(getattr(self.model, attr) == value)
        return (
            query
            .offset(skip)
            .limit(limit)
            .all()
        )


order = CRUDOrder(Order)