Metadata-Version: 2.4
Name: mongo
Version: 0.2.0
Summary: Minimalistic pymongo object wrapper
Home-page: https://github.com/imbolc/mongo
Author: Imbolc
Author-email: imbolc@imbolc.name
License: Copyright (c) 2012 Imbolc
        
        Permission to use, copy, modify, and/or distribute this software for any
        purpose with or without fee is hereby granted, provided that the above
        copyright notice and this permission notice appear in all copies.
        
        THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
        WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
        MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
        ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
        WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
        ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
        OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
        
Keywords: mongodb,pymongo,orm
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Programming Language :: Python
License-File: LICENSE
Requires-Dist: pymongo
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

mongo
=====

Minimalistic pymongo object wrapper


Document
--------

Minimal document model:

    >>> from mongo import Document, Index
    >>> class Doc(Document):
    ...     __database__ = 'mongo_test'  # database name


All allowed settings:

    >>> class Doc(Document):
    ...     __connection__ = {'host': 'localhost', 'port': 27017}
    ...     #__auth__ = ('username', 'password')
    ...     __database__ = 'mongo_test' # database name
    ...     __collection__ = 'test'     # collection name
    ...     __safe__ = True             # enable safe insert mode
    ...
    ...     __indexes__ = [
    ...         Index('number', unique=True, sparse=True),
    ...     ]


Clear collection
----------------

    >>> t = Doc.remove()
    >>> Doc.count()
    0


Create document
---------------
    
    >>> doc = Doc(foo='bar')
    >>> doc['number'] = 10
    >>> doc.save()
    >>> '_id' in doc
    True


Fetch
-----
Get by id:

    >>> doc1 = Doc.get_by_id(doc.id)
    >>> doc1 == doc
    True

Find one:

    >>> doc2 = Doc.find_one({'number': 10})
    >>> doc2 == doc
    True

Find:

    >>> doc3 = Doc.find({'number': 10}).limit(1)[0]
    >>> doc3 == doc
    True

Get or create:

    >>> doc4, new = Doc.get_or_create({'number': 10}, defaults={'foo': 'bar'})
    >>> new
    False
    >>> doc4 == doc
    True


Update
------

Update filtered documents:

    >>> t = Doc.update({'number': 10}, {'$set': {'text': 'foo'}})
    >>> doc = Doc.find_one({'number': 10})
    >>> doc['text']
    u'foo'

Save only some fields:

    >>> doc['text'] = u'bar'
    >>> doc['number'] = 11
    >>> doc.save_fields('text')
    >>> doc = Doc.find_one({'number': 10})
    >>> doc['text'], doc['number']
    (u'bar', 10)

Update only some fields:

    >>> doc.atomic_update({'$inc': {'number': 2}})
    >>> doc = Doc.find_one({'text': 'bar'})
    >>> doc['number']
    12


Counting
--------

    >>> Doc().save()
    >>> Doc.count()
    2
    >>> Doc.find({'number': 12}).count()
    1


Delete 
------

Remove single document:

    >>> t = doc.delete()
    >>> Doc.find_one({'number': 12})

Remove some documents:

    >>> t = Doc.remove({'number': 10})

Remove all documents:

    >>> t = Doc.remove()
