Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bitly/asyncmongo

An asynchronous library for accessing mongo with tornado.ioloop
https://github.com/bitly/asyncmongo

Last synced: 3 months ago
JSON representation

An asynchronous library for accessing mongo with tornado.ioloop

Awesome Lists containing this project

README

        

asyncmongo
==========

AsyncMongo is an asynchronous library for accessing mongo
which is built on the tornado ioloop.

[![Build Status](https://travis-ci.org/bitly/asyncmongo.png?branch=master)](https://travis-ci.org/bitly/asyncmongo)

Installation
------------

Installing: `pip install asyncmongo`

Usage
-----

asyncmongo syntax strives to be similar to [pymongo](http://api.mongodb.org/python/current/api/pymongo/collection.html).

import asyncmongo
import tornado.web

class Handler(tornado.web.RequestHandler):
@property
def db(self):
if not hasattr(self, '_db'):
self._db = asyncmongo.Client(pool_id='mydb', host='127.0.0.1', port=27017, maxcached=10, maxconnections=50, dbname='test')
return self._db

@tornado.web.asynchronous
def get(self):
self.db.users.find({'username': self.current_user}, limit=1, callback=self._on_response)
# or
# conn = self.db.connection(collectionname="...", dbname="...")
# conn.find(..., callback=self._on_response)

def _on_response(self, response, error):
if error:
raise tornado.web.HTTPError(500)
self.render('template', full_name=response['full_name'])

About
-----

Some features are not currently implemented:

* directly interfacing with indexes, dropping collections
* retrieving results in batches instead of all at once
(asyncmongo's nature means that no calls are blocking regardless of the number of results you are retrieving)
* tailable cursors #15

Requirements
------------
The following two python libraries are required

* [pymongo](http://github.com/mongodb/mongo-python-driver) version 1.9+ for bson library
* [tornado](http://github.com/facebook/tornado)

Issues
------

Please report any issues via [github issues](https://github.com/bitly/asyncmongo/issues)