Browse Source

Refs #34059 -- Doc'd lack of support for validation of constraints with JSONFields.

Thanks Dan LaManna for the report.
Mariusz Felisiak 2 years ago
parent
commit
004f985b91
2 changed files with 22 additions and 0 deletions
  1. 11 0
      docs/ref/models/constraints.txt
  2. 11 0
      docs/ref/models/instances.txt

+ 11 - 0
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.

+ 11 - 0
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