Update docs

Author: aclark4life

docs/howto/queryable-encryption.rst

@@ -194,28 +194,20 @@ Configuring the ``encrypted_fields_map``
 
 When you :ref:`configure an encrypted database connection
 <qe-configuring-databases-setting>` without specifying an
-``encrypted_fields_map`` in
-:class:`pymongo.encryption_options.AutoEncryptionOpts`, Django MongoDB Backend
-will create an encrypted fields map for you (when ``python manage.py migrate``
-is run), including new data keys, and use it to create collections for models
-with encrypted fields.
-
-The data keys are stored in the key vault :ref:`specified in the Django
-settings <qe-configuring-kms>`. You can view the encrypted fields map by running
-the :djadmin:`showencryptedfieldsmap` command.
+``encrypted_fields_map``, Django MongoDB Backend will create encrypted
+collections for you when you run ``python manage.py migrate``.
 
-To see the keys created by Django MongoDB Backend in the above scenario, you can
-run the following command::
+Encryption keys for encrypted fields are stored in the key vault
+:ref:`specified in the Django settings <qe-configuring-kms>`. To see the keys
+created by Django MongoDB Backend, along with the entire schema, you can run the
+:djadmin:`showencryptedfieldsmap` command::
 
     $ python manage.py showencryptedfieldsmap --database encrypted
 
-You can then use the output of the :djadmin:`showencryptedfieldsmap` command
-to set the ``encrypted_fields_map`` in
+Use the output of the :djadmin:`showencryptedfieldsmap` command to set the
+``encrypted_fields_map`` in
 :class:`pymongo.encryption_options.AutoEncryptionOpts` in your Django settings.
 
-Here is an example of how to configure the
-``encrypted_fields_map`` in your Django settings:
-
 .. code-block:: python
 
     from pymongo.encryption_options import AutoEncryptionOpts

docs/ref/models/encrypted-fields.rst

@@ -12,16 +12,18 @@ Queryable Encryption with Django MongoDB Backend.
 See the :doc:`/topics/queryable-encryption` topic guide for
 more information on developing applications with Queryable Encryption.
 
-The following fields are supported by Django MongoDB Backend for use with
+The following Django fields are supported by Django MongoDB Backend for use with
 Queryable Encryption.
 
 +----------------------------------------+------------------------------------------------------+
 | Encrypted Field                        | Django Field                                         |
 +========================================+======================================================+
-| ``EncryptedBooleanField``              | :class:`~django.db.models.BooleanField`              |
-+----------------------------------------+------------------------------------------------------+
 | ``EncryptedBigIntegerField``           | :class:`~django.db.models.BigIntegerField`           |
 +----------------------------------------+------------------------------------------------------+
+| ``EncryptedBinaryField``               | :class:`~django.db.models.BinaryField`               |
++----------------------------------------+------------------------------------------------------+
+| ``EncryptedBooleanField``              | :class:`~django.db.models.BooleanField`              |
++----------------------------------------+------------------------------------------------------+
 | ``EncryptedCharField``                 | :class:`~django.db.models.CharField`                 |
 +----------------------------------------+------------------------------------------------------+
 | ``EncryptedDateField``                 | :class:`~django.db.models.DateField`                 |
@@ -52,13 +54,32 @@ Queryable Encryption.
 +----------------------------------------+------------------------------------------------------+
 | ``EncryptedURLField``                  | :class:`~django.db.models.URLField`                  |
 +----------------------------------------+------------------------------------------------------+
+| ``EncryptedUUIDField``                 | :class:`~django.db.models.UUIDField`                 |
++----------------------------------------+------------------------------------------------------+
 
-The following fields are supported by Django MongoDB Backend but are not
-supported by Queryable Encryption.
+The following MongoDB-specific fields are supported by Django MongoDB Backend
+for use with Queryable Encryption.
+
++----------------------------------------+------------------------------------------------------+
+| Encrypted Field                        | MongoDB Field                                        |
++----------------------------------------+------------------------------------------------------+
+| ``EncryptedArrayField``                | :ref:`arrayfield`                                    |
++----------------------------------------+------------------------------------------------------+
+| ``EncryptedEmbeddedModelArrayField``   | :ref:`embeddedmodelarrayfield`                       |
++----------------------------------------+------------------------------------------------------+
+| ``EncryptedEmbeddedModelField``        | :ref:`embeddedmodelfield`                            |
++----------------------------------------+------------------------------------------------------+
+| ``EncryptedObjectIdField``             | :ref:`objectidfield`                                 |
++----------------------------------------+------------------------------------------------------+
+
+The following fields are supported by Django MongoDB Backend but not by
+Queryable Encryption.
 
-+--------------------------------------+-----------------------------------------------+
-| :class:`~django.db.models.SlugField` | Indexes aren't supported on encrypted fields. |
-+--------------------------------------+-----------------------------------------------+
++--------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+| Field                                | Limitation                                                                                                         |
++--------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+| :class:`~django.db.models.SlugField` | :ref:`Queryable Encryption does not support TTL Indexes or Unique Indexes <manual:qe-reference-encryption-limits>` |
++--------------------------------------+--------------------------------------------------------------------------------------------------------------------+
 
 ``EncryptedFieldMixin``
 =======================

docs/ref/models/fields.rst

@@ -46,6 +46,8 @@ MongoDB-specific model fields
 
 Some MongoDB-specific fields are available in ``django_mongodb_backend.fields``.
 
+.. _arrayfield:
+
 ``ArrayField``
 --------------
 
@@ -260,6 +262,8 @@ transform do not change. For example:
 
 These indexes use 0-based indexing.
 
+.. _embeddedmodelfield:
+
 ``EmbeddedModelField``
 ----------------------
 
@@ -310,6 +314,8 @@ These indexes use 0-based indexing.
     created these models and then added an indexed field to ``Address``,
     the index created in the nested ``Book`` embed is not created.
 
+.. _embeddedmodelarrayfield:
+
 ``EmbeddedModelArrayField``
 ---------------------------
 
@@ -346,6 +352,8 @@ These indexes use 0-based indexing.
     This field is typically the default primary key field for all models stored
     in MongoDB. See :ref:`specifying the-default-pk-field`.
 
+.. _objectidfield:
+
 ``ObjectIdField``
 -----------------
 

docs/topics/queryable-encryption.rst

@@ -4,25 +4,36 @@ Queryable Encryption
 
 .. versionadded:: 5.2.3
 
-Once you have configured your Django project and MongoDB deployment for
-Queryable Encryption, you’re ready to start developing applications that take
-advantage of these enhanced security features.
+Once you have successfully set up MongoDB Queryable Encryption as described in
+:doc:`the installation guide </howto/queryable-encryption>`, you can start
+using encrypted fields in your Django models.
 
 Encrypted fields
 ================
 
-You can use :doc:`encrypted fields </ref/models/encrypted-fields>` to structure
-your sensitive data.
-
-
 The basics
 ----------
 
-For example, you can define models with encrypted fields like this:
+:doc:`Encrypted fields </ref/models/encrypted-fields>` may be used to protect
+sensitive data like social security numbers, credit card information, or
+personal health information. With Queryable Encryption, you can also perform
+queries on certain encrypted fields. To use encrypted fields in your models,
+import the necessary field types from ``django_mongodb_backend.models`` and
+define your models as usual.
 
 .. code-block:: python
 
-    class Patient(EncryptedTestModel):
+    # myapp/models.py
+    from django.db import models
+    from django_mongodb_backend.models import EmbeddedModel
+    from django_mongodb_backend.fields import (
+        EmbeddedModelField,
+        EncryptedCharField,
+        EncryptedEmbeddedModelField,
+    )
+
+
+    class Patient(models.Model):
         patient_name = models.CharField(max_length=255)
         patient_id = models.BigIntegerField()
         patient_record = EmbeddedModelField("PatientRecord")