mongoengine - Ignore extra fields for schema validation

Question

I am trying to query my database. Some records currently have extra fields that are not included in my model schema (by error, but I want to handle these cases). When I try to query the DB and transform the records into the schema, I get the following error:

FieldDoesNotExist
The field 'X' does not exist on the document 'Y'

Because of the extra fields in the database that differ from the schema.

Is there a way to ignore this schema validation for extra fields in mongoengine?

score 62 · Accepted Answer · answered Dec 01 '15 at 15:14

62

For ignoring this error when having extra fields while data loading, set strict to False in your meta dictionary.

class User(Document):
    email = StringField(required=True, unique=True)
    password = StringField()
    meta = {'strict': False}

answered Dec 01 '15 at 15:14

toto11

1,552
1
17
18

1

References: https://mongoengine-odm.readthedocs.io/apireference.html#mongoengine.Document https://mongoengine-odm.readthedocs.io/apireference.html#mongoengine.FieldDoesNotExist – Wtower Dec 15 '16 at 07:44

score 11 · Answer 2 · answered Jun 19 '15 at 02:00

11

I believe you want to use a DynamicDocument instead of a Document when defining your model and that will allow extra fields in the db schema to be ignored.

answered Jun 19 '15 at 02:00

typemismatch

2,047
3
23
26

6

So, what is the difference between using *strict* in meta as of @JFathi and DynamicDocument? – gia huy Jan 15 '21 at 06:17
@gia huy, DynamicDocument implies that it is expected behaviour in production to have extra fields. "strict" implies that it's not really okay, but that you are willing to be sloppy. For instance, while you are developing and the schema is still changing a lot, you might want to set strict to false in that development phase. – jastram Mar 14 '23 at 09:17

score 2 · Answer 3 · answered Apr 11 '15 at 09:50

2

I think you want skip schema validation, so when you save your document

document_name.save(validate=False)

answered Apr 11 '15 at 09:50

geek4079

539
2
6
15

1

Hey, thanks for the response! This would work but I still would like the fields in my schema to be validated, I just also want to ignore any extra fields that are returned in my records. The obvious method is to use the only() on all my fields, but that isn't very nice. – Andrew Apr 11 '15 at 19:21

score 0 · Answer 4 · answered Nov 29 '18 at 13:02

You can extend from mon.DynamicDocument.

class AF(mon.DynamicDocument):
  meta = {
    'collection': 'af'
  }
user_id = mon.StringField(db_field='customer_user_id')

You can see from the document. A Dynamic Document class is allowing flexible, expandable and uncontrolled schemas.

score 0 · Answer 5 · answered Feb 08 '21 at 03:32

0

Just define your class with DynamicDocument

class Y(DynamicDocument):
    pass

Add whatever attrs you want

o=Y()
o.attr1="abc"

Save it ;-) without error

o.save()

answered Feb 08 '21 at 03:32

Aseem Jain

333
2
7

mongoengine - Ignore extra fields for schema validation

5 Answers5

Just define your class with DynamicDocument

Add whatever attrs you want

Save it ;-) without error

Linked