Extends django check constraint to support annotations.
Project description
django-check-constraint
Extends Django's Check constraint with support for UDF(User defined functions/db functions) and annotations.
Installation
$ pip install django-check-constraint
ADD check_constraint
to list of INSTALLED APPS.
INSTALLED_APPS = [
...
"check_constraint",
...
]
Scenario:
Suppose you have a database function that returns the counts of null values in [i, ...n]
.
CREATE OR REPLACE FUNCTION public.non_null_count(VARIADIC arg_array ANYARRAY)
RETURNS BIGINT AS
$$
SELECT COUNT(x) FROM UNNEST($1) AS x
$$ LANGUAGE SQL IMMUTABLE;
Example:
SELECT public.non_null_count(1, null, null);
Outputs:
non_null_count
----------------
1
(1 row)
Defining a check constraint with this function
The equivalent of (PostgresSQL)
ALTER TABLE app_name_test_modoel ADD CONSTRAINT app_name_test_model_optional_field_provided
CHECK(non_null_count(amount::integer , amount_off::integer, percentage::integer) = 1);
Usage
Converting this to django functions and annotated check contraints can be done using:
function.py
from django.db.models import Func, SmallIntegerField, TextField
from django.db.models.functions import Cast
class NotNullCount(Func):
function = 'non_null_count'
def __init__(self, *expressions, **extra):
filter_exp = [
Cast(exp, TextField()) for exp in expressions if isinstance(exp, str)
]
if 'output_field' not in extra:
extra['output_field'] = SmallIntegerField()
if len(expressions) < 2:
raise ValueError('NotNullCount must take at least two expressions')
super().__init__(*filter_exp, **extra)
Creating annotated check constraints
from django.db import models
from django.db.models import Q
from check_constraint.models import AnnotatedCheckConstraint
class TestModel(models.Model):
amount = models.DecimalField(max_digits=9, decimal_places=2, null=True, blank=True)
amount_off = models.DecimalField(max_digits=7, decimal_places=2, null=True, blank=True)
percentage = models.DecimalField(max_digits=3, decimal_places=0, null=True, blank=True)
class Meta:
constraints = [
AnnotatedCheckConstraint(
check=Q(not_null_count=1),
annotations={
'not_null_count': (
NotNullCount(
'amount',
'amount_off',
'percentage',
)
),
},
name='%(app_label)s_%(class)s_optional_field_provided',
),
]
TODO's
- Add support for schema based functions.
- Add warning about mysql lack of user defined check constraint support.
- Remove skipped sqlite3 test.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for django-check-constraint-1.0.14.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 04434adb1c3ba302bf03645e44e95436ec930241f62c520094c6f123daa34413 |
|
MD5 | be29412f198f525a76d5e70d837b5ae9 |
|
BLAKE2b-256 | 589730907e1e18b638e1277050219d650dffa7ae040f2df527d2c5d71a0c15be |
Close
Hashes for django_check_constraint-1.0.14-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 274b9b52fe6856cdae455cacf473eff9f90e82b4a0c56279c759b99aab00e26c |
|
MD5 | 494b78b981af8ac9685c4bfda7d5bd5f |
|
BLAKE2b-256 | 155a8c82fb210823e1ee1681fae0cbd604e2438b655b5cc91b4f09cfe98579da |