SQLAlchemy - クエリオブジェクトにカスタムメソッドを追加できますか？

Question

クエリオブジェクトにカスタムメソッドを作成して、このようなことを行う方法はありますか？ all_active()は、本質的に.filter(User.is_active == True)

あり、それのオフフィルタすることができ

User.query.all_active() 

？

User.query.all_active().filter(User.age == 30) 

Answer 1

あなたがあなた自身のメソッドを追加するために基本Queryクラスをサブクラス化することができます

from sqlalchemy.orm import Query 

class MyQuery(Query): 

    def all_active(self): 
    return self.filter(User.is_active == True) 

あなたは、あなたがセッション（docs here）を作成するときに、この新しいクエリクラスを使用するSQLAlchemyのを教えてください。あなたのコードからは、フラスコSQLAlchemyのを使用している場合がありますように見えますので、次のようにあなたはそれを行うだろう：

db = SQLAlchemy(session_options={'query_cls': MyQuery}) 

は、そうしないと、sessionmakerに直接引数を渡すことになります。

sessionmaker(bind=engine, query_cls=MyQuery) 

右のとおり現在、この新しいクエリオブジェクトは、メソッド内にUserクラスをハードコードしたので興味深いわけではないので、他のものでは機能しません。より良い実装では、クエリの基底クラスを使用して、適用するフィルタを決定します。これは少しトリッキーですが、同様に行うことができます（あなたがいずれかを持っている場合）

class MyOtherQuery(Query): 

    def _get_models(self): 
    """Returns the query's underlying model classes.""" 
    if hasattr(query, 'attr'): 
     # we are dealing with a subquery 
     return [query.attr.target_mapper] 
    else: 
     return [ 
     d['expr'].class_ 
     for d in query.column_descriptions 
     if isinstance(d['expr'], Mapper) 
     ] 

    def all_active(self): 
    model_class = self._get_models()[0] 
    return self.filter(model_class.is_active == True) 

は最後に、この新しいクエリクラスは動的な関係で使用されることはありません。あなたが関係を作成するときに引数として渡すことができ、それらはまた、それを使用できるようにするには：どちらかといえば

users = relationship(..., query_class=MyOtherQuery)