Skip to content

Commit a30a562

Browse files
committed
Address UAT feedback
1 parent 0393c81 commit a30a562

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

docs/howto/queryable-encryption.rst

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To install the optional dependencies, use pip with the ``encryption`` extra:
3030

3131
.. code-block:: console
3232
33-
$ pip install django-mongodb-backend[encryption]
33+
$ pip install 'django-mongodb-backend[encryption]'
3434
3535
Next, download the :ref:`Automatic Encryption Shared Library
3636
<manual:qe-csfle-shared-library-download>`. You can choose the latest version,
@@ -62,11 +62,11 @@ Here's a sample configuration using a local KMS provider::
6262
"encrypted": {
6363
"ENGINE": "django_mongodb_backend",
6464
"HOST": "mongodb+srv://cluster0.example.mongodb.net",
65-
"NAME": "my_encrypted_database",
65+
"NAME": "encrypted",
6666
# ...
6767
"OPTIONS": {
6868
"auto_encryption_opts": AutoEncryptionOpts(
69-
key_vault_namespace="my_encrypted_database.__keyVault",
69+
key_vault_namespace="encrypted.__keyVault",
7070
kms_providers={
7171
"local": {
7272
# Generated by os.urandom(96)
@@ -280,7 +280,7 @@ You can perform a equality query just like you would on a non-encrypted field:
280280
.. code-block:: pycon
281281
282282
>>> patient = Patient.objects.get(patient_record__ssn="123-45-6789")
283-
>>> patient.name
283+
>>> patient.patient_name
284284
'John Doe'
285285
286286
.. _qe-configuring-kms:
@@ -340,6 +340,14 @@ Here's an example of KMS configuration with ``aws``::
340340
Configuring the ``encrypted_fields_map`` option
341341
===============================================
342342

343+
344+
.. admonition:: Required configuration
345+
346+
As :ref:`described here <qe-showencryptedfieldsmap-required-configuration>`,
347+
ensure ``django_mongodb_backend`` is listed in
348+
:setting:`django:INSTALLED_APPS` to enable the
349+
:djadmin:`showencryptedfieldsmap` command.
350+
343351
Encryption keys are created when you :ref:`run migrations for models that have
344352
encrypted fields <qe-migrations>`.
345353

docs/ref/django-admin.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Management commands
55
Django MongoDB Backend includes some :doc:`Django management commands
66
<django:ref/django-admin>`.
77

8+
.. _qe-showencryptedfieldsmap-required-configuration:
9+
810
Required configuration
911
======================
1012

0 commit comments

Comments
 (0)