Django REST framework: pagination on PostgreSQL triggers

Sat 02 April 2016

Django and Django REST Framework use SQL COUNT in pagination. As your database grows SQL COUNT becomes too slow. Fortunately the frameworks are well designed and allow to customize a way items are count. Let me illustrate that on a typical "books" example.

class Author(models.Model):
    name = models.CharField()

    class Meta:
        db_table = 'author'


class Book(models.Model):
    author = models.ForeignKey(Author, related_name='books')

    class Meta:
        db_table = 'book'

It has been working fine for some time but authors are so productive and wrote thousands of books. As a result alice.books.count() takes a few seconds to execute. One option is to store books count in Author model which might be helpful in other SQL queries. Another one is to keep count somewhere else, e.g., Redis.

class Author(models.Model):
    name = models.CharField()
    books_count = models.PositiveIntegerField(null=True)

    class Meta:
        db_table = 'author'

Note that books_count is nullable due to existing data on production servers. Setting a default value 0 on schema migration would take long to update every author record, also it's hard to tell whether an author record is already migrated (books_count is calculated or not).

Now we have Author.books_count field which should keep track of new books. You can implement that based on Django signals or SQL triggers.

Signals might fail, even with send_robust. Updating a books count in a signal receiver slows down an application (two to three DB queries and acquiring a DB lock on author record):

@receiver(post_save, sender=Book, dispatch_uid='update_author_books_count')
def update_author_books_count(sender, instance, created, **kwargs):
    if not created:
        return
    book = instance

    with atomic():
        author = Author.objects.select_for_update().get(pk=book.author_id)
        if author.books_count is None:
            author.books_count = author.books.count()
        else:
            author.books_count += 1
        author.save()

Moving an update logic from a signal receiver to Celery task doesn't look promising -- books_count would be inconsistent between a task trigger and its execution or simply Celery task might fail. Another issue is that a model signal is not "attached" to DB transaction. For example, a Celery task is run before a DB transaction is committed. That is usually quick fixed with task_name.apply_async(countdown=1) to delay a task execution, but I would rather recommend something like django-transaction-hooks.

What about SQL trigger option? A bad thing is that a business logic leaks from an app to DB. But with a good documentation and tests it's maintainable: SQL code is stored in a data migration module.

$ python manage.py makemigrations --empty yourappname
from django.db import migrations

CREATE_FUNCTION_SQL = """
CREATE OR REPLACE FUNCTION update_books_count_on_author() RETURNS trigger AS $$
    BEGIN
        UPDATE author SET books_count =
            CASE
                WHEN books_count IS NULL THEN (
                    SELECT count(*) FROM book WHERE author_id = author.id
                )
                ELSE books_count + 1
            END
        WHERE id = NEW.author_id;

        RETURN NEW;
    END;
$$ LANGUAGE plpgsql;
"""

CREATE_TRIGGER_SQL = """
CREATE TRIGGER books_count_update
    AFTER INSERT ON book
    FOR EACH ROW
    EXECUTE PROCEDURE update_books_count_on_author();
"""


class Migration(migrations.Migration):
    dependencies = []
    operations = [
        migrations.RunSQL(CREATE_FUNCTION_SQL),
        migrations.RunSQL(CREATE_TRIGGER_SQL),
    ]

Here is a pitfall though. When a new book is created and author is updated on the same DB transaction, then books_count value might be overwritten.

with atomic():
    author = Author.objects.select_for_update().get(pk=author_id)
    Book.objects.create(author=author)
    author.name = 'Bob'
    author.save()

You can either explicitly list fields to update author.save(update_fields=['name']) or use django-save-the-change. Let's document that in the model docstring.

from save_the_change.mixins import SaveTheChange


class Author(SaveTheChange, models.Model):
    """Author, e.g., Terry Pratchett.

    :attribute books_count: How many books writer has. SQL COUNT is
        expensive operation, so we store calculated value and update it
        by SQL trigger (check a data migration module for details).
        It's important to save only fields that were updated in the model.
        Otherwise SQL trigger's results are overwritten by Django ORM.
        For example:

        1. author is requested with a lock (books_count = 1)
        2. new book is created
        3. SQL trigger updates author's books_count field (now it is 2)
        4. author instance is saved with the old value of books_count = 1.

        SaveTheChange mixin helps to prevent it.

    """

To benefit from books_count field in Django REST Framework we need a custom pagination class which implements Paginator.count property. The idea is to extract author ID from paginator's SQL, query a books count from Author model and return it, instead of default Book.objects.filter(author_id=author_id).count().

from django.core.paginator import Paginator
from rest_framework import pagination
from rest_framework.viewsets import ReadOnlyModelViewSet


class BookViewSet(ReadOnlyModelViewSet):
    pagination_class = BookPagination


class BookPagination(pagination.PageNumberPagination):
    django_paginator_class = CachedBookCountPaginator


class CachedBookCountPaginator(Paginator):
    @cached_property
    def count(self):
        """Return the total number of books, across all pages.

        It parses a SQL and learns what author ID was requested
        based on ``self.object_list.query``. After that we can get
        a cached books count from Author model.

        """
        # There is query.where, but I could't find an author ID easily.
        # Moreover query.where internals might be changed.
        sql = str(self.object_list.query)
        author_id = self._get_author_id_from_sql(sql)

        author = Author.objects.get(pk=author_id).only('books_count')
        # In case we got unsynced author, we fallback to SQL COUNT.
        if author.books_count is None:
            return self.query_count()

        return author.books_count

    def query_count(self):
        """Request books count from DB.

        We need this method to facilitate testing (mocks).

        """
        return super(CachedBookCountPaginator, self).count

@classmethod
def _get_author_id_from_sql(cls, sql):
    pass

I hope this helps. Cheers!

Category: Python Tagged: python django postgresql django rest framework pagination

comments


API based on Flask

Mon 09 December 2013

Here I want to consider implementation of API best practices which usually don't follow Fielding's REST strictly. Example Flask project is on GitHub.

API Versioning

Interfaces are changed hence versioning is mandatory in order to not annoy your users. You might need to add new resource or field to particular …

Category: Python Tagged: python flask api

comments

Read More

Preparation to Python Interview

Fri 02 November 2012

I decided to collect a little more information and experience during preparation to Python developer interview. These are some information and links which seemed important to me. Maybe it will be helpful.

How does it usually go?

What kind of projects did you participate in?

What did you do at …

Category: Python Tagged: python interview

comments

Read More

Стартап fangid.com

Sat 13 October 2012

В середине июля 2012 г. команда стартапа fangid.com приступила к воплощению идеи социальной концертной платформы на севере Таиланда. Я занимался подготовительными работами (соглашениями по разработке, первоначальной подготовкой репозитория, например, продумыванием структуры, организацией тестов, разделением настроек), принимал участие в выработке требований к системе и проектировании архитектуры. При конструировании системы моими …

Category: Portfolio Tagged: python django startup thailand

comments

Read More

Портфолио 2007–2011

Fri 12 October 2012

Не стал перечислять те сайты, которые за давностью лет были переделаны либо перестали существовать. В основном backend основан на cms myscon, которая была переписана мною несколько раз.

2011

  • электронный архив ежемесячного литературно-публицистического журнала «Агидель» на Django. Предполагается, что ресурс будет содержать архив журналов с 1923 года. Для удобной навигации сделал …

Category: Portfolio Tagged: php codeigniter cms myscon python django

comments

Read More

Django TODO: тестирование во время конструирования

Fri 29 June 2012

Тестирование, выполняемое разработчиками -- один из важнейших элементов полной стратегии тестирования.

Тестирование может указать только на отдельные дефектные области программы -- оно не сделает программу удобнее в использовании, более быстрой, компактной, удобочитаемой или расширяемой.

Цель тестирования противоположна целям других этапов разработки. Его целью является нахождение ошибок. Успешным считается тест, нарушающий работу ПО …

Category: Python Tagged: python django django-todo testing

comments

Read More

Django TODO: конструирование системы

Fri 29 June 2012

При работе над проектом конструирование включает другие процессы, в том числе проектирование. Формальная архитектура дает ответы только на вопросы системного уровня, при этом значительная часть проектирования может быть намеренно оставлена на этап конструирования. Проектирование -- это "постепенный" процесс. Проекты приложений не возникают в умах разработчиков сразу в готовом виде. Они развиваются …

Category: Python Tagged: python django django-todo construction

comments

Read More

Django TODO: проектирование архитектуры системы

Fri 29 June 2012

Следующим этапом разработки системы является проектирование архитектуры.

Архитектура должна быть продуманным концептуальным целым. Главный тезис самой популярной книги по разработке ПО "Мифический человеко-месяц" гласит, что основной проблемой, характерной для крупных систем, является поддержание их концептуальной целостности. Хорошая архитектура должна соответствовать проблеме [1].

Разделение системы на подсистемы на уровне архитектуры, позволяет …

Category: Python Tagged: python django django-todo architecture

comments

Read More

Django TODO: выработка требований к системе

Fri 29 June 2012

После прочтения Макконелла захотелось спроецировать его советы на Django. Для этого я взял за основу разработку системы Django TODO. Итак, первый этап -- выработка требований к системе.

Требования подробно описывают, что должна делать система. Внимание к требованиям помогает свести к минимуму изменения системы после начала разработки. Явные требования помогают гарантировать, что …

Category: Python Tagged: python django django-todo requirements

comments

Read More

Соглашения по разработке на Python/Django

Fri 29 June 2012

Во время разработки я часто сверяюсь с известными мне соглашениями, стараюсь следовать рекомендациям. Цитировать их не имеет смысла -- лучше приведу ссылки.

PEP 8 -- Style Guide for Python Code.

Code Like a Pythonista: Idiomatic Python. В нем я нашел ответы на вопросы форматирования длинных строк:

expended_time = (self.finish_date() - self.start_date
                 + datetime …

Category: Python Tagged: python django best practices

comments

Read More

Разделение настроек в Django

Fri 29 June 2012

В Django wiki собраны различные способы разделения настроек. Мне нравится вариант, описанный в блоге Senko Rašić:

settings/
├── __init__.py
├── base.py
├── development.py
├── local.py
└── production.py

base.py содержит общие настройки для development.py и production.py, например:

ADMINS = ()
MANAGERS = ADMINS

TIME_ZONE = 'Asia/Yekaterinburg'
# ...

production.py содержит настройки для …

Category: Python Tagged: python django settings

comments

Read More

Краткий обзор инфраструктуры для разработки reusable Django приложений

Wed 13 June 2012

Начиная впервые разрабатывать веб-приложения на новом фреймворке программист зачастую сталкивается с некоторыми трудностями. При разработке отчуждаемых веб-приложений на Django к этим проблемам необходимо отнести организацию файлов в проекте, обнаружение тестов, вопросы пакетирования приложений и организации автоматизированного тестирования. В данной статье приведены пути решения этих проблем.

Важно знать различия между двумя …

Category: Python Tagged: python django infrastructure

comments

Read More

Моделирование одноканальной СМО с отказами

Sat 30 May 2009

Дана одноканальная система массового обслуживания с отказами. В нее поступают заявки через промежуток времени n, где n – случайная величина, подчиненная равномерному закону распределения. Время обслуживания заявки системой m также является случайной величиной с показательным законом распределения. Если к моменту прихода заявки канал занят, заявка покидает систему необслуженной.

Изначально код был …

Category: Misc Tagged: python modeling single-channel queue

comments

Read More