dbref – Tools for manipulating DBRefs (references to documents stored in MongoDB) — PyMongo 2.5 documentation

### Navigation

- index
- modules |
- next |
- previous |
- PyMongo 2.5 documentation »
- API Documentation »
- `bson` – BSON (Binary JSON) Encoding and Decoding »

# `dbref` – Tools for manipulating DBRefs (references to documents stored in MongoDB)

Tools for manipulating DBRefs (references to MongoDB documents).

class `bson.dbref.``DBRef`(collection, id, database=None, _extra={}, **kwargs)

  Initialize a new `DBRef`.

  Raises `TypeError` if collection or database is not an instance of `basestring` (`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

  Changed in version 1.8: Now takes keyword arguments to specify additional fields.

  New in version 1.1.1: The database parameter.

  See general MongoDB documentation

  dbrefs

  `as_doc`()

    Get the SON document representation of this DBRef.

    Generally not needed by application developers

  `collection`

    Get the name of this DBRef’s collection as unicode.

  `database`

    Get the name of this DBRef’s database.

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

    New in version 1.1.1.

  `id`

    Get this DBRef’s _id.

### Navigation

- index
- modules |
- next |
- previous |
- PyMongo 2.5 documentation »
- API Documentation »
- `bson` – BSON (Binary JSON) Encoding and Decoding »