Skip to main content

Django app that lets you define custom SQL functions

Project description

PyPI pyversions Django versions PyPI version GitHub release

Django SQL Fun

Django SQLFun allows you to define and manage custom SQL functions in code. When you change the function definitions and call makemigrations, it will generate migrations for any functions that have been added, removed, or changed. These function classes can also be used in Django querysets since the SqlFun class inherits from django.db.models.expressions.Func.

Note: I'm still developing this so there may be some rough edges. Breaking changes may happen.


  1. Install using your favorite python package manager, eg. pip install django-sqlfun.
  2. Add sqlfun to INSTALLED_APPS in your django settings
  3. Run migrate. This will set up any tables required by sqlfun to keep track of your custom funcitons


  1. Define a custom function in a module that gets imported on project load (eg. See below for example, or the test_project.
  2. Run makemigrations
  3. Run migrate


Define a custom function in your

from sqlfun import SqlFun
from django.db.models import IntegerField

class BadSum(SqlFun):
    """Almost returns the sum of two numbers."""
    app_label = 'test_project' # [optional] if omitted, sqlfun will atempt to auto-resolve it
    sql = """
            first integer,
            second integer
        ) RETURNS integer as $$
        SELECT first + second + 1;
        LANGUAGE sql
    output_field = IntegerField()

Then run makemigrations and migrate and you should be good to go. You can use it in SQL: SELECT bad_sum(2, 2), or in a Python queryset like so: MyModel.objects.annotate(foo=BadSum(Value(2), Value(2))).


  • SQL functions are normalized, so changes in white-space should not result in changes being detected
  • the --dry-run and --name options of makemigrations are respected


These instructions assume a recent Ubuntu/Debian environment.

  1. Clone the repository
  2. If needed, install python3-venv and python3-pip packages
  3. Create a virtual environment python3 -m venv .venv
  4. Install libpq-dev package since psycopg2 depends on it.
  5. Install pdm: pip3 install --user pdm
  6. Install dev dependencies with pdm install --dev

Testing also requires a recent install of docker which is used to spin up a test postgres instance.


This project is inspired by two great projects: django-pgtrigger and django-pgviews.

Project details

Download files

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

Source Distribution

django-sqlfun-0.0.7.tar.gz (11.6 kB view hashes)

Uploaded Source

Built Distribution

django_sqlfun-0.0.7-py3-none-any.whl (8.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page