How to filter objects for count annotation in Django?
Consider simple Django models
class Event(models.Model): title = models.CharField(max_length=100) class Participant(models.Model): event = models.ForeignKey(Event, db_index=True) is_paid = models.BooleanField(default=False, db_index=True)
It's easy to annotate events query with total number of participants:
events = Event.objects.all().annotate(participants=models.Count('participant'))
How to annotate with count of participants filtered by
I need to query all events regardless of number of participants, e.g. I don't need to filter by annotated result. If there are
0 participants, that's ok, I just need
0 in annotated value.
The example from documentation doesn't work here, because it excludes objects from query instead of annotating them with
Update. Django 1.8 has new conditional expressions feature, so now we can do like this:
events = Event.objects.all().annotate(paid_participants=models.Sum( models.Case( models.When(participant__is_paid=True, then=1), default=0, output_field=models.IntegerField() )))
Conditional aggregation in Django 2.0 allows you to further reduce the amount of faff this has been in the past. This will also use Postgres'
filter logic, which is somewhat faster than a sum-case (I've seen numbers like 20-30% bandied around).
Anyway, in your case, we're looking at something as simple as:
events = Event.objects.annotate( paid_participants=Count('participants', filter=Q(participants__is_paid=True)) )
There's a separate section in the docs about filtering on annotations. It's the same stuff as conditional aggregation but more like my example above. Either which way, this is a lot healthier than the gnarly subqueries I was doing before.
★ Back to homepage or read more recommendations: