dbref
– Tools for manipulating DBRefs (references to documents stored in MongoDB)#
Tools for manipulating DBRefs (references to MongoDB documents).
- class bson.dbref.DBRef(collection: str, id: Any, database: str | None = None, _extra: Mapping[str, Any] | None = None, **kwargs: Any)#
Initialize a new
DBRef
.Raises
TypeError
if collection or database is not an instance ofstr
. database is optional and allows references to documents to work across databases. Any additional keyword arguments will create additional fields in the resultant embedded document.- Parameters:
collection: name of the collection the document is stored in
id: the value of the document’s
"_id"
fielddatabase (optional): name of the database to reference
**kwargs (optional): additional keyword arguments will create additional, custom fields
See also
The MongoDB documentation on dbrefs.
- as_doc() SON[str, Any] #
Get the SON document representation of this DBRef.
Generally not needed by application developers