OpenQuizz
Une application de gestion des contenus pédagogiques
DBRef Class Reference
Inheritance diagram for DBRef:
Collaboration diagram for DBRef:

Public Member Functions

def __init__ (self, collection, id, database=None, _extra={}, **kwargs)
 
def collection (self)
 
def id (self)
 
def database (self)
 
def __getattr__ (self, key)
 
def __setstate__ (self, state)
 
def as_doc (self)
 
def __repr__ (self)
 
def __eq__ (self, other)
 
def __ne__ (self, other)
 
def __hash__ (self)
 
def __deepcopy__ (self, memo)
 

Detailed Description

A reference to a document stored in MongoDB.

Constructor & Destructor Documentation

◆ __init__()

def __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

.. mongodoc:: dbrefs

Member Function Documentation

◆ __deepcopy__()

def __deepcopy__ (   self,
  memo 
)
Support function for `copy.deepcopy()`.

◆ __eq__()

def __eq__ (   self,
  other 
)

◆ __getattr__()

def __getattr__ (   self,
  key 
)

◆ __hash__()

def __hash__ (   self)
Get a hash value for this :class:`DBRef`.

◆ __ne__()

def __ne__ (   self,
  other 
)

◆ __repr__()

def __repr__ (   self)

◆ __setstate__()

def __setstate__ (   self,
  state 
)

◆ as_doc()

def as_doc (   self)
Get the SON document representation of this DBRef.

Generally not needed by application developers

◆ collection()

def collection (   self)
Get the name of this DBRef's collection as unicode.

◆ database()

def database (   self)
Get the name of this DBRef's database.

Returns None if this DBRef doesn't specify a database.

◆ id()

def id (   self)
Get this DBRef's _id.

The documentation for this class was generated from the following file: