Skip to content

Commit 917e3a8

Browse files
committed
Code review fixes (5/x)
1 parent e1c3e43 commit 917e3a8

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
@@ -469,16 +469,7 @@ built-in fields before storing it in the database.
469469
| ``EncryptedURLField`` | :class:`~django.db.models.URLField` |
470470
+----------------------------------------+------------------------------------------------------+
471471

472-
.. _encrypted-fields-unsupported-fields:
473-
474-
.. admonition:: Unsupported fields
475-
476-
The following fields are supported by Django MongoDB Backend but are not
477-
supported by Queryable Encryption.
478-
479-
:class:`~django.db.models.SlugField` - Queryable Encryption does not
480-
:doc:`support unique indexes on encrypted fields
481-
<manual:core/queryable-encryption/reference/limitations>`.
472+
.. class:: EncryptedFieldMixin
482473

483474
``EncryptedFieldMixin``
484475
-----------------------
@@ -501,3 +492,15 @@ for the field::
501492
queries={"queryType": "equality"},
502493
# Other field options...
503494
)
495+
496+
Unsupported fields
497+
------------------
498+
499+
The following fields are supported by Django MongoDB Backend but are not
500+
supported by Queryable Encryption.
501+
502+
+--------------------------------------+------------------------------------------------------------+
503+
| :class:`~django.db.models.SlugField` | Queryable Encryption does not :doc:`support unique indexes |
504+
| | on encrypted fields |
505+
| | <manual:core/queryable-encryption/reference/limitations>`. |
506+
+--------------------------------------+------------------------------------------------------------+

0 commit comments

Comments
 (0)