对SQLAlchemy中的所有查询应用LIMIT和OFFSET

Question

我正在设计一个带有SQLAlchemy（查询MySQL）的API，我想强制所有查询都有page-size（LIMIT）和page-number（OFFSET）参数。

使用SQLAlchemy有一种干净的方法吗？或许可以建立某种类型的工厂来创建自定义查询对象？或者也许有一个很好的方法来解决这个问题？

我尝试了显而易见的方法，但没有成功，因为必须在应用所有筛选条件后调用.limit（）和.offset（）：

def q(page=0, page_size=None):
    q = session.query(...)
    if page_size: q = q.limit(page_size)
    if page: q = q.offset(page*page_size)
    return q

当我尝试使用这个时，我得到一个例外：

sqlalchemy.exc.InvalidRequestError: Query.filter() being called on a Query which already has LIMIT or OFFSET applied. To modify the row-limited results of a  Query, call from_self() first.  Otherwise, call filter() before limit() or offset() are applied.

Answer 1

尝试添加第一个必需参数，该参数必须是一组查询筛选器。因此

# q({'id': 5}, 2, 50)
def q(filters, page=0, page_size=None):
    query = session.query(...).filter_by(**filters)
    if page_size:
        query = query.limit(page_size)
    if page: 
        query = query.offset(page*page_size)
    return query

或者

# q(Model.id == 5, 2, 50)
def q(filter, page=0, page_size=None):
    query = session.query(...).filter(filter)
    if page_size:
        query = query.limit(page_size)
    if page: 
        query = query.offset(page*page_size)
    return query

Answer 2

您可以调用query.limit(None).来删除以前应用的限制或偏移量。

Answer 3

在这个问题出现时不是一个选项，因为版本1.0.0可以利用Query events来确保limit和offset方法总是在编译query对象之前调用，在q函数的用户执行任何操作之后调用：

from sqlalchemy.event import listen


def q(page=0, page_size=None):
    query = session.query()
    listen(query, 'before_compile', apply_limit(page, page_size), retval=True)
    return query

def apply_limit(page, page_size):
    def wrapped(query):
        if page_size:
            query = query.limit(page_size)
            if page:
                query = query.offset(page * page_size)
        return query
    return wrapped