Skip to main content
https://badge.fury.io/py/django-rank-query.svg https://travis-ci.org/petrdlouhy/django-rank-query.svg?branch=master https://codecov.io/gh/petrdlouhy/django-rank-query/branch/master/graph/badge.svg

Enable SQL Window functions for use in Django queries. Add rank to your query.

Django in curren’t version (1.10) doesn’t support [window functions](https://www.postgresql.org/docs/9.3/static/functions-window.html) as seen in PostgreSQL. This implemets rank, dense_rank and adds shortcut for upper_rank, which retrieves upper value for rank (rank of last element in the window). The implementation is currently working only on PostgreSQL.

Note: The support for window functions is being already solved in [issue #26608](https://code.djangoproject.com/ticket/26608).

Quickstart

Install rank:

pip install django-rank-query

Usage

U can annotate users by rank (sequenc number in alphabet) of their last name the like this:

from rank import DenseRank, UpperRank, Rank
users = User.objects.all()
users = user.annotate(lower_rank=Rank('last_name'))
users = user.annotate(upper_rank=UpperRank('last_name'))
users = user.annotate(dense_rank=DenseRank('last_name'))

Then you have user query annotated with various ranks. You can retrieve them for example by values function:

user_ranks = users.values('last_name', 'lower_rank', 'upper_rank')

Note: PostgreSQL doesn’t support combining rank functions with GROUP_BY or in WHERE clause. So you cannot use them in aggregation queries.

Rank is counted in the current select query, so filtering will change rank of given elements, so you can’t have sequence number in whole table filtered by ie. his name. This can be solved by using subqueries in SQL, but Django doesn’t support them as far as I know.

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits

Tools used in rendering this package:

History

0.1.0 (2017-01-20)

  • First release on PyPI.

Release files for django-rank-query 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-rank-query 0.1.0
File Size Uploaded
django-rank-query-0.1.0.tar.gz 16.5 kB Details

Release files / django-rank-query-0.1.0.tar.gz

Download URL django-rank-query-0.1.0.tar.gz
Size 16.5 kB
Tags Source
SHA-256 checksum
How to use checksums
6eef9d1c4048977494cc89be241d4c36a53a485ef00d4aedf2c974d0c70f941f
BLAKE2b-256 checksum
How to use checksums
036da0af2e03979daa744d018f23931a59a9d3fd3b1696ce86c33955c1f45489
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.0 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page