Skip to content

Improve doc for querying by dict #2926

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.

Sign up for GitHub

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

Merged
bagerard merged 1 commit into from
Aug 23, 2026
+22 −0
Merged

Improve doc for querying by dict #2926

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/guide/querying.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,28 @@ syntax::
# been written by a user whose 'country' field is set to 'uk'
uk_pages = Page.objects(author__country='uk')

.. warning::

Be aware that MongoDB considers field order when matching an embedded
document. As a result, querying a :class:`~mongoengine.fields.DictField` or
:class:`~mongoengine.fields.MapField` against a complete dictionary only
matches when its keys are in the same order as the stored document. The same
applies when querying an :class:`~mongoengine.fields.EmbeddedDocumentField`
with an embedded document instance. For example, this query may not match
when the stored keys are in the opposite order::

SurveyResponse.objects(
answers={"question_2": "no", "question_1": "yes"},
)

Query individual dictionary keys to match their values regardless of
order::

SurveyResponse.objects(
answers__question_1="yes",
answers__question_2="no",
)

.. note::

(version **0.9.1+**) if your field name is like mongodb operator name (for example
Expand Down