API Reference¶
Document¶
-
class
umongo.
Document
(**kwargs)[source]¶ -
classmethod
build_from_mongo
(data, partial=False, use_cls=False)[source]¶ Create a document instance from MongoDB data
Parameters: - data – data as retrieved from MongoDB
- use_cls – if the data contains a
_cls
field, use it determine the Document class to instanciate
-
dbref
¶ Return a pymongo DBRef instance related to the document
-
dump
(schema=None)[source]¶ Dump the document: return a
dict
Parameters: schema – use this schema for the dump instead of the default one
-
from_mongo
(data, partial=False)[source]¶ Update the document with the MongoDB data
Parameters: data – data as retrieved from MongoDB
-
pk
¶ Return the document’s primary key (i.e. _id in mongo notation) or None if not available yet
-
classmethod
Fields¶
-
umongo.fields.
StrField
¶ alias of
StringField
-
umongo.fields.
BoolField
¶ alias of
BooleanField
-
umongo.fields.
IntField
¶ alias of
IntegerField
-
class
umongo.fields.
ObjectIdField
(*args, io_validate=None, unique=False, **kwargs)[source]¶ Marshmallow field for
bson.ObjectId
-
class
umongo.fields.
ReferenceField
(document_cls, *args, reference_cls=<class 'umongo.data_objects.Reference'>, **kwargs)[source]¶ -
document_cls
¶
-
Data objects¶
-
class
umongo.data_objects.
EmbeddedDocument
(**kwargs)[source]¶ -
Schema
¶ alias of
EmbeddedDocumentSchema
-
schema
= <EmbeddedDocumentSchema(many=False, strict=False)>¶
-