Code review fixes (2/x)

Author: aclark4life

django_mongodb_backend/schema.py

@@ -5,9 +5,10 @@
 from pymongo.encryption import ClientEncryption
 from pymongo.operations import SearchIndexModel
 
+from django_mongodb_backend.indexes import SearchIndex
+
 from .fields import EmbeddedModelField
 from .gis.schema import GISSchemaEditor
-from .indexes import SearchIndex
 from .model_utils import model_has_encrypted_fields
 from .query import wrap_database_errors
 from .utils import OperationCollector

docs/source/howto/queryable-encryption.rst

@@ -27,11 +27,12 @@ Configuring the ``DATABASES`` setting
 =====================================
 
 In addition to :ref:`configuring-databases-setting`, you must also configure an
-encrypted database in your ``DATABASES`` setting.
+encrypted database in your :setting:`django:DATABASES` setting.
 
 This database will be used to store encrypted fields in your models. The
 following example shows how to configure an encrypted database using the
-``AutoEncryptionOpts`` from the ``pymongo.encryption_options`` module.
+:class:`pymongo.encryption_options.AutoEncryptionOpts` from the
+:mod:`pymongo.encryption_options` module.
 
 This example uses a local KMS provider and a key vault namespace for storing
 encryption keys.
@@ -60,9 +61,10 @@ encryption keys.
 Configuring the ``DATABASE_ROUTERS`` setting
 ============================================
 
-Similar to :ref:`configuring-database-routers-setting` for using embedded
-models, to use Queryable Encryption, you must also configure the
-``DATABASE_ROUTERS`` setting to route queries to the encrypted database.
+Similar to :ref:`configuring-database-routers-setting` for using :doc:`embedded
+models </topics/embedded-models>`, to use Queryable Encryption you must also
+configure the :setting:`django:DATABASE_ROUTERS` setting to route queries to the
+encrypted database.
 
 This is done by adding a custom router that routes queries to the encrypted
 database based on the model's metadata. The following example shows how to
@@ -94,3 +96,25 @@ configure a custom router for Queryable Encryption:
 
 Configuring KMS Providers
 =========================
+
+To use Queryable Encryption, you must configure a Key Management Service (KMS)
+provider. The KMS provider is responsible for managing the encryption keys used
+to encrypt and decrypt data. The following table summarizes the available KMS
+provider options and how to configure them:
+
++-------------------------------------------------------------------------+---------------------------------------+
+| :setting:`KMS_CREDENTIALS <DATABASE-KMS-CREDENTIALS>`                   | A dictionary of Key Management        |
+|                                                                         | Service (KMS) credentials             |
+|                                                                         | configured in the                     |
+|                                                                         | :setting:`django:DATABASES`           |
+|                                                                         | setting.                              |
++-------------------------------------------------------------------------+---------------------------------------+
+| :class:`kms_providers <pymongo.encryption_options.AutoEncryptionOpts>`  | Map of KMS provider credentials and   |
+|                                                                         | options. The ``kms_providers`` map    |
+|                                                                         | values differ by provider and are     |
+|                                                                         | required to access KMS services.      |
++-------------------------------------------------------------------------+---------------------------------------+
+| ``kms_provider``                                                        | A single KMS provider name            |
+|                                                                         | configured in your custom database    |
+|                                                                         | router.                               |
++-------------------------------------------------------------------------+---------------------------------------+

docs/source/ref/django-admin.rst

@@ -17,7 +17,7 @@ Available commands
 ``showencryptedfieldsmap``
 --------------------------
 
-.. versionadded:: 5.2.0b2
+.. versionadded:: 5.2.0rc1
 
 .. django-admin:: showencryptedfieldsmap
 

docs/source/ref/models/encrypted-fields.rst

@@ -4,6 +4,17 @@ Encrypted fields
 
 .. versionadded:: 5.2.0rc1
 
+Django MongoDB Backend supports :doc:`manual:core/queryable-encryption`.
+
+See :doc:`/howto/queryable-encryption` for more information on how to use
+Queryable Encryption with Django MongoDB Backend.
+
+See the :doc:`Queryable Encryption topic </topics/queryable-encryption>` for
+more information on developing applications with Queryable Encryption.
+
+The following fields are supported by Django MongoDB Backend for use with
+Queryable Encryption.
+
 +----------------------------------------+------------------------------------------------------+
 | Encrypted Field                        | Django Field                                         |
 +========================================+======================================================+

docs/source/ref/settings.rst

@@ -12,6 +12,8 @@ Key Management Service (KMS) credentials for Queryable Encryption.
 
 .. setting:: DATABASE-KMS-CREDENTIALS
 
+.. _database-kms-credentials:
+
 ``KMS_CREDENTIALS``
 -------------------
 
@@ -23,8 +25,8 @@ Vault, or GCP KMS) for encrypting and decrypting data using Queryable
 Encryption.
 
 For example after :doc:`/howto/queryable-encryption`, to configure AWS KMS,
-Azure Key Vault, or GCP KMS credentials, you can set the ``KMS_CREDENTIALS``
-in your ``DATABASES`` settings as follows:
+Azure Key Vault, or GCP KMS credentials, you can set ``KMS_CREDENTIALS`` in
+your :setting:`django:DATABASES` settings as follows:
 
 .. code-block:: python