API Documentation
=================

.. currentmodule:: mango

Externals
---------

The parts of the API described in this section are used to interact with a MongoDB database and define Documents.

Connecting to a MongoDB Server
******************************

.. autoclass:: mango.Client


Defining Documents
******************

.. autofunction:: mango.assign


.. autoclass:: mango.Document

   .. automethod:: save

   .. automethod:: find_matching

   .. automethod:: find_self

   .. automethod:: find


.. autofunction:: mango.utils.filter_dict

.. autofunction:: mango.register

Working with Documents
**********************

.. autofunction:: mango.save_many


Utilities
---------

The parts of the API described in this section are peripheral helper functions.

.. autofunction:: mango.utils.run_mongodb


Internals
---------

The parts of the API described in this section are used internally by Mango but should not need to be referenced externally.


.. autoclass:: Database


.. autoclass:: Collection


.. autoclass:: Cursor