This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

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

Project Description

Django Aggregate If: Condition aggregates for Django

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"
    REVOKED = "REVOKED"
    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

Offer.objects.count()
Offer.objects.filter(status=Offer.OPEN).aggregate(Count('pk'))
Offer.objects.filter(status=Offer.REVOKED).aggregate(Count('pk'))
Offer.objects.filter(status=Offer.PAID).aggregate(Count('pk'))
Offer.objects.aggregate(Sum('price'))
Offer.objects.filter(status=Offer.OPEN).aggregate(Sum('price'))
Offer.objects.filter(status=Offer.REVOKED).aggregate(Sum('price'))
Offer.objects.filter(status=Offer.PAID).aggregate(Sum('price'))

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

Offer.objects.aggregate(
    pk__count=Count('pk'),
    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__sum=Sum('price'),
    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))
)

Installation

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

To install it, simply:

$ pip install django-aggregate-if

Inspiration

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.

Limitations

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.

Changelog

0.5
  • Support for Django 1.7
0.4
  • 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.
0.3.1
  • Fix quotation escaping.
  • Fix boolean casts on Postgres.
0.2
  • Fix postgres issue with LIKE conditions.
0.1
  • Initial release.

License

The MIT License.

Release History

Release History

This version
History Node

0.5

History Node

0.4

History Node

0.3.1

History Node

0.3

History Node

0.2

History Node

0.1

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
django-aggregate-if-0.5.tar.gz (5.1 kB) Copy SHA256 Checksum SHA256 Source Nov 18, 2014

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting