SQLAlchemy - can you add custom methods to the query object?

Question

Is there a way to create custom methods to the query object so you can do something like this?

User.query.all_active() 

Where all_active() is essentially .filter(User.is_active == True)

And be able to filter off of it?

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

Answer 1

You can subclass the base Query class to add your own methods:

from sqlalchemy.orm import Query  class MyQuery(Query):    def all_active(self):     return self.filter(User.is_active == True) 

You then tell SQLAlchemy to use this new query class when you create the session (docs here). From your code it looks like you might be using Flask-SQLAlchemy, so you would do it as follows:

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

Otherwise you would pass the argument directly to the sessionmaker:

sessionmaker(bind=engine, query_cls=MyQuery) 

As of right now, this new query object isn't that interesting because we hardcoded the User class in the method, so it won't work for anything else. A better implementation would use the query's underlying class to determine which filter to apply. This is slightly tricky but can be done as well:

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) 

Finally, this new query class won't be used by dynamic relationships (if you have any). To let those also use it, you can pass it as argument when you create the relationship:

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

Answer 2

this work for me finely

class ParentQuery(Query):     def _get_models(self):              if hasattr(query, 'attr'):             return [query.attr.target_mapper]         else:             return self._mapper_zero().class_      def FilterByCustomer(self):         model_class = self._get_models()         return self.filter(model_class.customerId == int(g.customer.get('customerId')))   class AccountWorkflowModel(db.Model):     query_class = ParentQuery     .................