summaryrefslogtreecommitdiff
path: root/docs/ref/contrib/postgres/validators.txt
blob: 5e12b969fe8b208a7654ecb58f6fbb34ded5abc4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
==========
Validators
==========

.. module:: django.contrib.postgres.validators

These validators are available from the ``django.contrib.postgres.validators``
module.

``KeysValidator``
=================

.. class:: KeysValidator(keys, strict=False, messages=None)

    Validates that the given keys are contained in the value. If ``strict`` is
    ``True``, then it also checks that there are no other keys present.

    The ``messages`` passed should be a dict containing the keys
    ``missing_keys`` and/or ``extra_keys``.

    .. note::
        Note that this checks only for the existence of a given key, not that
        the value of a key is non-empty.

Range validators
================

``RangeMaxValueValidator``
--------------------------

.. class:: RangeMaxValueValidator(limit_value, message=None)

    Validates that the upper bound of the range is not greater than
    ``limit_value``.

``RangeMinValueValidator``
--------------------------

.. class:: RangeMinValueValidator(limit_value, message=None)

    Validates that the lower bound of the range is not less than the
    ``limit_value``.