Как фильтровать объекты для аннотации счетчика в Django?

Question

Рассмотрим простые модели Django Event и Participant:

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) 

Легко аннотировать событий запрос с общим количеством участников:

events = Event.objects.all().annotate(participants=models.Count('participant')) 

Как аннотирования с кол-участников фильтруется is_paid=True?

Мне нужно запросить все события независимо от количества участников, например. Мне не нужно фильтровать аннотированный результат. Если есть 0 участников, это нормально, мне просто нужно 0 в аннотированном значении.

example from documentation здесь не работает, поскольку он исключает объекты из запроса вместо аннотирования их 0.

Обновление. Django 1.8 имеет новый conditional expressions feature, так что теперь мы можем сделать так:

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() 
    ))) 

Update 2. Django 2.0 имеет новую функцию Conditional aggregation см the accepted answer ниже.

Answer 1

Conditional aggregation в Django 2.0 позволяет вам еще больше уменьшить количество ошибок, которые были в прошлом. Это также будет использовать логику Postgres 'filter, которая несколько быстрее, чем суммарная (я видел цифры, подобные 20-30%).

Во всяком случае, в вашем случае, мы смотрим на что-то просто:

events = Event.objects.annotate(
    paid_participants=Count('participants', filter=Q(participants__is_paid=True)) 
) 

Там есть отдельный раздел в документации о filtering on annotations. Это то же самое, что и условная агрегация, но больше похоже на мой пример выше. Так или иначе, это намного здоровее, чем гнарные подзапросы, которые я делал раньше.

Answer 2

ОБНОВЛЕНИЕ

Подход суб-запрос, который я уже теперь поддерживается в Django 1.11 с помощью subquery-expressions.

Event.objects.annotate(
    num_paid_participants=Subquery(
     Participant.objects.filter(
      is_paid=True, 
      event=OuterRef('pk') 
     ).values('event') 
     .annotate(cnt=Count('pk')) 
     .values('cnt'), 
     output_field=models.IntegerField() 
    ) 
) 

Я предпочитаю это по агрегации (сумма + случай), потому что она должна быть быстрее и легче оптимизировать (с правильной индексации).

Для более старой версии, то же самое может быть достигнуто с помощью .extra

Event.objects.extra(select={'num_paid_participants': "\ 
    SELECT COUNT(*) \ 
    FROM `myapp_participant` \ 
    WHERE `myapp_participant`.`is_paid` = 1 AND \ 
      `myapp_participant`.`event_id` = `myapp_event`.`id`" 
}) 

Answer 3

Просто обнаружил, что Django 1.8 имеет новый conditional expressions feature, так что теперь мы можем сделать так:

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() 
    ))) 

Answer 4

Я хотел бы предложить используйте метод .values вашего запроса Participant.

Для краткости, что вы хотите сделать, это определяется по формуле:

Participant.objects\ 
    .filter(is_paid=True)\ 
    .values('event')\ 
    .distinct()\ 
    .annotate(models.Count('id')) 

полный пример выглядит следующим образом:

1. Создать 2 Event S:

   event1 = Event.objects.create(title='event1') 
   event2 = Event.objects.create(title='event2') 
   

2. Add Participant s к ним:

   part1l = [Participant.objects.create(event=event1, is_paid=((_%2) == 0))\ 
         for _ in range(10)] 
   part2l = [Participant.objects.create(event=event2, is_paid=((_%2) == 0))\ 
         for _ in range(50)] 
   

3. Group все Participant s по их event поле:

   Participant.objects.values('event') 
   > <QuerySet [{'event': 1}, {'event': 1}, {'event': 1}, {'event': 1}, {'event': 1}, {'event': 1}, {'event': 1}, {'event': 1}, {'event': 1}, {'event': 1}, {'event': 2}, {'event': 2}, {'event': 2}, {'event': 2}, {'event': 2}, {'event': 2}, {'event': 2}, {'event': 2}, {'event': 2}, {'event': 2}, '...(remaining elements truncated)...']> 
   

   Здесь нужен отчетливый:

   Participant.objects.values('event').distinct() 
   > <QuerySet [{'event': 1}, {'event': 2}]> 
   

   Что .values и .distinct делают здесь в том, что они создают два ведра Participant s сгруппированы по их элементу event. Обратите внимание, что эти ведра содержат Participant.

4. Вы можете затем аннотировать эти ведра, поскольку они содержат набор оригинальных Participant. Здесь мы хотим, чтобы подсчитать количество Participant, это просто сделано путем подсчета id х элементов в этих ведрах (так как те Participant):

   Participant.objects\ 
       .values('event')\ 
       .distinct()\ 
       .annotate(models.Count('id')) 
   > <QuerySet [{'event': 1, 'id__count': 10}, {'event': 2, 'id__count': 50}]> 
   

5. Наконец, вы хотите только Participant с is_paid быть True , вы можете просто добавить фильтр перед предыдущим выражением, и это выход выражение было показано выше:

   Participant.objects\ 
       .filter(is_paid=True)\ 
       .values('event')\ 
       .distinct()\ 
       .annotate(models.Count('id')) 
   > <QuerySet [{'event': 1, 'id__count': 5}, {'event': 2, 'id__count': 25}]> 
   

Единственным недостатком является то го вам нужно будет вернуть Event, поскольку у вас есть только id по методу выше.