MongoEngine / MongoEngine/mongoengine

Query MapField by a key that matches one of the field names in the nested document fails with a mongoengine.errors.InvalidQueryError

Open
#2,714 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
4.3k
Forks
1.2k
Avg merge
4h 41m
Merged PRs (30d)
11

Description

Here is the class hierarchy:

class DataItem(EmbeddedDocument):
    key = StringField(required=True)
    value = StringField(required=True)

class MyDoc(Document):
    data = MapField(
        field=EmbeddedDocumentField(DataItem)
    )
    

And the data in db:

{
    "_id" : ObjectId("63a87cb374d6bc3efd9ea570"),
    "data" : {
        "key" : {
            "key" : "1",
            "value" : "test"
        }
    }
}
{
    "_id" : ObjectId("63a87cb374d6bc3efd9ea571"),
    "data" : {
        "a" : {
            "key" : "2",
            "value" : "test"
        }
    }
}

The query MyDoc.objects(data__a__value="test").first() succeeds while the query MyDoc.objects(data__key__value="test").first() fails with mongoengine.errors.InvalidQueryError: Cannot resolve field "value"

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the two MyDoc.objects queries shown in the report and inspect how the MapField path is resolved when the map key is also a nested field name. Trace the InvalidQueryError path and add coverage for both data__a__value and data__key__value, with the latter resolving consistently rather than failing.

Written by the indexing model from the issue text.

Assessment

Tech stack
mongodb, python
Domain
databases
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.