summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorMariusz Felisiak <felisiak.mariusz@gmail.com>2022-10-12 11:50:13 +0200
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2022-10-12 11:51:26 +0200
commitf72ba56af07d30a5b46df802536a11b330efbe10 (patch)
treeb1b497cae22d1bc56a400923708207e45a4689cb /docs/ref
parent950a84ce42e087a665449a1323e868d6660efbeb (diff)
[4.1.x] Refs #34059 -- Doc'd lack of support for validation of constraints with JSONFields.
Thanks Dan LaManna for the report. Backport of 004f985b918d5ea36fbed9b050459dd22edaf396 from main
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/models/constraints.txt11
-rw-r--r--docs/ref/models/instances.txt11
2 files changed, 22 insertions, 0 deletions
diff --git a/docs/ref/models/constraints.txt b/docs/ref/models/constraints.txt
index b52f754294..d3fde02e04 100644
--- a/docs/ref/models/constraints.txt
+++ b/docs/ref/models/constraints.txt
@@ -34,6 +34,17 @@ option.
Constraints are checked during the :ref:`model validation
<validating-objects>`.
+.. admonition:: Validation of Constraints with ``JSONField``
+
+ Constraints containing :class:`~django.db.models.JSONField` may not raise
+ validation errors as key, index, and path transforms have many
+ database-specific caveats. This :ticket:`may be fully supported later
+ <34059>`.
+
+ You should always check that there are no log messages, in the
+ ``django.db.models`` logger, like *"Got a database error calling check() on
+ …"* to confirm it's validated properly.
+
.. versionchanged:: 4.1
In older versions, constraints were not checked during model validation.
diff --git a/docs/ref/models/instances.txt b/docs/ref/models/instances.txt
index 7d5b1317a7..0f8c330972 100644
--- a/docs/ref/models/instances.txt
+++ b/docs/ref/models/instances.txt
@@ -211,6 +211,17 @@ need to call a model's :meth:`~Model.full_clean()` method if you plan to handle
validation errors yourself, or if you have excluded fields from the
:class:`~django.forms.ModelForm` that require validation.
+.. warning::
+
+ Constraints containing :class:`~django.db.models.JSONField` may not raise
+ validation errors as key, index, and path transforms have many
+ database-specific caveats. This :ticket:`may be fully supported later
+ <34059>`.
+
+ You should always check that there are no log messages, in the
+ ``django.db.models`` logger, like *"Got a database error calling check() on
+ …"* to confirm it's validated properly.
+
.. versionchanged:: 4.1
In older versions, constraints were not checked during the model