Extends django check constraint to support annotations.
Project description
django-check-constraint
Complex check constraint support for Django.
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
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_name_test_model_optional_field_provided',
),
]
:warning: Currently this doesn't support schema specific functions.
TODO's
[ ] Add support for schema based functions.
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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | faf60d48830364267a8cc7180d7c5944e164db4ef8ddfa8d69d63f98251d8209 |
|
MD5 | c009e7679f71839fd4f49659de8c254a |
|
BLAKE2b-256 | 63aabbd63adc08535217843a55e673232444f0efc341ea51d72381beedd7a801 |
Close
Hashes for django_check_constraint-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd4a3522502b1006ae5bcac7f33784054eb3b32c8272456effa5c651acad7aa8 |
|
MD5 | 8c412d0c9b9dadd68f907934534409d5 |
|
BLAKE2b-256 | 4a60252f84c1a69c41d4ceb101b1eff351400609390e75d5605f7ca7aaa413d1 |