Skip to content

Commit 2d4b8b7

Browse files
committed
Code review fixes (5/x)
1 parent 20de1f2 commit 2d4b8b7

File tree

2 files changed

+15
-10
lines changed

2 files changed

+15
-10
lines changed

docs/source/howto/queryable-encryption.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ steps required for Django.
2020
Prerequisites
2121
-------------
2222

23+
.. TODO Add something about crypt_shared here.
24+
2325
In addition to :doc:`installing </intro/install>` and :doc:`configuring
2426
</intro/configure>` Django MongoDB Backend, you will need to install some
2527
additional packages to use Queryable Encryption. This can be done with the

docs/source/ref/models/fields.rst

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -458,16 +458,7 @@ built-in fields before storing it in the database.
458458
| ``EncryptedURLField`` | :class:`~django.db.models.URLField` |
459459
+----------------------------------------+------------------------------------------------------+
460460

461-
.. _encrypted-fields-unsupported-fields:
462-
463-
.. admonition:: Unsupported fields
464-
465-
The following fields are supported by Django MongoDB Backend but are not
466-
supported by Queryable Encryption.
467-
468-
:class:`~django.db.models.SlugField` - Queryable Encryption does not
469-
:doc:`support unique indexes on encrypted fields
470-
<manual:core/queryable-encryption/reference/limitations>`.
461+
.. class:: EncryptedFieldMixin
471462

472463
``EncryptedFieldMixin``
473464
-----------------------
@@ -490,3 +481,15 @@ for the field::
490481
queries={"queryType": "equality"},
491482
# Other field options...
492483
)
484+
485+
Unsupported fields
486+
------------------
487+
488+
The following fields are supported by Django MongoDB Backend but are not
489+
supported by Queryable Encryption.
490+
491+
+--------------------------------------+------------------------------------------------------------+
492+
| :class:`~django.db.models.SlugField` | Queryable Encryption does not :doc:`support unique indexes |
493+
| | on encrypted fields |
494+
| | <manual:core/queryable-encryption/reference/limitations>`. |
495+
+--------------------------------------+------------------------------------------------------------+

0 commit comments

Comments
 (0)