A reference to a document stored in MongoDB.
| def bson.dbref.DBRef.__init__ |
( |
|
self, |
|
|
|
collection, |
|
|
|
id, |
|
|
|
database = None, |
|
|
|
_extra = {}, |
|
|
|
kwargs |
|
) |
| |
Initialize a new :class:`DBRef`.
Raises :class:`TypeError` if `collection` or `database` is not
an instance of :class:`basestring` (:class:`str` in python 3).
`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"`` field
- `database` (optional): name of the database to reference
- `**kwargs` (optional): additional keyword arguments will
create additional, custom fields
.. versionchanged:: 1.8
Now takes keyword arguments to specify additional fields.
.. versionadded:: 1.1.1
The `database` parameter.
.. mongodoc:: dbrefs
| def bson.dbref.DBRef.__deepcopy__ |
( |
|
self, |
|
|
|
memo |
|
) |
| |
Support function for `copy.deepcopy()`.
.. versionadded:: 1.10
| def bson.dbref.DBRef.__hash__ |
( |
|
self | ) |
|
Get a hash value for this :class:`DBRef`.
.. versionadded:: 1.1
| def bson.dbref.DBRef.as_doc |
( |
|
self | ) |
|
Get the SON document representation of this DBRef.
Generally not needed by application developers
| def bson.dbref.DBRef.collection |
( |
|
self | ) |
|
Get the name of this DBRef's collection as unicode.
| def bson.dbref.DBRef.database |
( |
|
self | ) |
|
Get the name of this DBRef's database.
Returns None if this DBRef doesn't specify a database.
.. versionadded:: 1.1.1
| def bson.dbref.DBRef.id |
( |
|
self | ) |
|
The documentation for this class was generated from the following file:
1.8.2