web-dev-qa-db-ja.com

SQLAlchemyのすべてのクエリにLIMITおよびOFFSETを適用する

SQLAlchemy（MySQLのクエリ）を使用してAPIを設計しています。すべてのクエリにpage_size（LIMIT）およびpage_number（OFFSET）パラメータを強制的に設定したいと思います。

SQLAlchemyでこれを行うクリーンな方法はありますか？おそらく、カスタムクエリオブジェクトを作成するために、ある種のファクトリを構築しているでしょうか？それとも、mixinクラスでこれを行う良い方法がありますか？

私は明白なことを試してみましたが、すべてのフィルター条件が適用された後に.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.
pythonsqlalchemyapi-design
35
Rob Crowell

クエリフィルタのグループである必要がある最初の必須引数を追加してみてください。したがって、

# 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
36
pydsigner

この質問の時点ではオプションではありません。バージョン1.0.0以降では、 クエリイベント を利用して、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
1
Daniele