for any info/changes follow me: @nickmilon

Welcome to mongoUtils’s documentation!

mongoUtils

A toolcase with utilities for mongoDB based mainly on pymongo useful also as mongoDB example usage and best practices.
This library has been in developement as pymongo_ext until major changes in pymongo version 3 broke backward compatibility, it is now rewrittern from scratch.

Note

Installation:pip install mongoUtils
Dependencies:

  • pymongo (installed automatically by setup)

  • Hellas (installed automatically by setup) a lightweight python utilities library of mine

  • gevent (optional) not a prerequisite but will be used by pyMongo if installed

  • xlrd library (optional used only for importing Excel workbooks into mongo to install it:
    >>> pip install xlrd)
Usage:
See documentation of individual modules and classes
All examples require the existance of testing database and collections which are installed during execution of tests.
Also if mongoDB is not running on local host port 27017, testDbConStr connection string in configuration.py should be edited.
Most examples require establishing a connection to testing database.
>>> from pymongo import MongoClient;                        # import MongoClient
>>> from mongoUtils.client import muClient                  # or alternativly this client
>>> from mongoUtils.configuration import testDbConStr       # import conection string
>>> client = muClient(testDbConStr)                         # establish a client connection
>>> db = client.get_default_database()                      # get test database
Tests:
  • to run tests

    python -m mongoUtils.tests.tests -v

classes Diagram

Note:click on a class to view documentation

Inheritance diagram of mongoUtils.client, mongoUtils.importsExports, mongoUtils.aggregation, mongoUtils.mapreduce, mongoUtils.pubsub, mongoUtils.helpers, mongoUtils.examples, mongoUtils.tests.tests, mongoUtils.tests.PubSubBench

Indices and tables