django/docs/ref/contrib/postgres/validators.txt
Marten Kenbeek a79789e232 [2.1.x] Added import locations to contrib.postgres aggregates and validators docs.
Backport of 7a6dbbb655850bff56cd717a3bfa0975e200d15f from master.
2018-12-24 16:36:14 -05:00

43 lines
1.1 KiB
Plaintext

==========
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``.