Skip to content

INTPYTHON-527 Add Queryable Encryption support #329

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

aclark4life
Copy link
Collaborator

@aclark4life aclark4life commented Jun 27, 2025

Previous attempts and additional context here:

@aclark4life

This comment was marked as resolved.

@timgraham

This comment was marked as resolved.

@aclark4life

This comment was marked as resolved.

@timgraham

This comment was marked as resolved.

@aclark4life

This comment was marked as resolved.

@aclark4life

This comment was marked as resolved.

@aclark4life

This comment was marked as resolved.

@aclark4life

This comment was marked as resolved.

@timgraham

This comment was marked as resolved.

@aclark4life

This comment was marked as resolved.

@aclark4life

This comment was marked as resolved.

@aclark4life

This comment was marked as resolved.

@timgraham

This comment was marked as resolved.

@aclark4life

This comment was marked as resolved.

@timgraham

This comment was marked as resolved.

Copilot

This comment was marked as resolved.

@mongodb mongodb deleted a comment from Copilot AI Aug 12, 2025
@timgraham

This comment was marked as resolved.

Comment on lines 91 to 102
Encrypted fields map
~~~~~~~~~~~~~~~~~~~~

In addition to the :ref:`settings described in the how-to guide
<queryable-encryption-settings>` you will need to provide a
``encrypted_fields_map`` to the ``AutoEncryptionOpts``.

You can use the :djadmin:`showencryptedfieldsmap` management command to generate
the schema map for your encrypted fields and then use the results in your
settings::

python manage.py showencryptedfieldsmap --database=encrypted
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're missing the step on defining your models (consolidate from topic guide?), then makemigrations and migrate. Otherwise showencryptedfieldsmap may crash without any keyIds to retrieve?

aclark4life and others added 9 commits August 13, 2025 12:08
QE Doc flow

- Three top level (or close to it) docs
 - How to guide on QE configuration
 - QE field guide (moved out of model field ref to its own section)
 - Topic guide on QE usage
- Planning to finish QE setup in the how-to doc then switch back to the
  topic doc to explain the workflow.
In the QE topics guide I'm going to explain how to develop a patient model
similar to the Python QE tutorial and the encryption test suite.

If embedding were possible now, I could present the same example. Since
embedded models are a WIP I may either:

- design the guide to work around that issue
- design the guide to anticipate resolution of that issue

In ether case, I'll try to wrap this 24-48 hour docs jam having covered
everything I know about QE and Django and having presented it to Django
folks in a way we can support.
- Configuring the encrypted_fields_map section
- Configuring the Automatic Encryption Shared Library
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants