Skip to main content

Conditional aggregates for Django, just like the famous SumIf in Excel.

Project description

Django Aggregate If: Condition aggregates for Django

Test Status Code Helth Latest PyPI version Number of PyPI downloads

Aggregate-if adds conditional aggregates to Django.

Conditional aggregates can help you reduce the ammount of queries to obtain aggregated information, like statistics for example.

Imagine you have a model Offer like this one:

class Offer(models.Model):
    sponsor = models.ForeignKey(User)
    price = models.DecimalField(max_digits=9, decimal_places=2)
    status = models.CharField(max_length=30)
    expire_at = models.DateField(null=True, blank=True)
    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)

    OPEN = "OPEN"
    PAID = "PAID"

Let’s say you want to know:

  1. How many offers exists in total;
  2. How many of them are OPEN, REVOKED or PAID;
  3. How much money was offered in total;
  4. How much money is in OPEN, REVOKED and PAID offers;

To get these informations, you could query:

from django.db.models import Count, Sum


In this case, 8 queries were needed to retrieve the desired information.

With conditional aggregates you can get it all with only 1 query:

from django.db.models import Q
from aggregate_if import Count, Sum

    pk__open__count=Count('pk', only=Q(status=Offer.OPEN)),
    pk__revoked__count=Count('pk', only=Q(status=Offer.REVOKED)),
    pk__paid__count=Count('pk', only=Q(status=Offer.PAID)),
    pk__open__sum=Sum('price', only=Q(status=Offer.OPEN)),
    pk__revoked__sum=Sum('price'), only=Q(status=Offer.REVOKED)),
    pk__paid__sum=Sum('price'), only=Q(status=Offer.PAID))


Aggregate-if works with Django 1.4, 1.5, 1.6 and 1.7.

To install it, simply:

$ pip install django-aggregate-if


There is a 5 years old ticket 11305 that will (hopefully) implement this feature into Django 1.8.

Using Django 1.6, I still wanted to avoid creating custom queries for very simple conditional aggregations. So I’ve cherry picked those ideas and others from the internet and built this library.

This library uses the same API and tests proposed on ticket 11305, so when the new feature is available you can easily replace django-aggregate-if.


Conditions involving joins with aliases are not supported yet. If you want to help adding this feature, you’re welcome to check the first issue.


  • Support for Django 1.7
  • Use tox to run tests.
  • Add support for Django 1.6.
  • Add support for Python3.
  • The only parameter now freely supports joins independent of the main query.
  • Adds support for alias relabeling permitting excludes and updates with aggregates filtered on remote foreign key relations.
  • Fix quotation escaping.
  • Fix boolean casts on Postgres.
  • Fix postgres issue with LIKE conditions.
  • Initial release.


The MIT License.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-aggregate-if, version 0.5
Filename, size File type Python version Upload date Hashes
Filename, size django-aggregate-if-0.5.tar.gz (5.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page