Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
MongoDB db engine and simple adapter for Django
Python Shell
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
djmongo
.gitignore
.travis.yml
MANIFEST.in
README.rst
manage.py
run_test_and_report.sh
setup.py
tests.py
tox.ini

README.rst

djmongo

https://secure.travis-ci.org/lukaszb/djmongo.png?branch=master

djmongo is yet another mongodb adapter for Django. This one however, is build directly on pymongo, tries to be as small and simple as possible and mimics Django's ORM (managers/querysets).

djmongo supports Django >= 1.3.

Installation

To install djmongo simply run:

pip install djmongo

Configuration

djmongo provides database engine so configuration is rather straight-forward:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': 'database.sqlite',
        'TEST_NAME': ':memory:',
    },

    'mongodb': {
        'ENGINE': 'djmongo.backend.mongodb',
        'NAME': 'testdb',
    }
}

In above example we added mongodb aliased connection to local mongodb server.

In your settings you should also provide MONGODB_COLLECTIONS_PREFIX value. By default documents would use it as a prefix for all collections. In example following docuemnt:

class Item(Document):
    pass

with MONGODB_COLLECTIONS_PREFIX set to develop. would have collection name equal to develop.item.

If you want to override default collection name you should always remember to use that prefix from settings (only collections with that prefix are dropped during test run).

Usage

Create a document:

from djmongo.document import Document
from django.conf import settings

class MyDocument(Document):

    class Meta:
        using = 'mongodb'

doc1 = MyDocument.objects.create(data={'foo': 'bar'})
doc2 = MyDocument.objects.create(data={'foo': 'baz'})

...

Testing

In order to properly test an application, one would like to destroy all objects inserted during test run between test cases. Normally, Django does that using transactions, however we need to destroy objects manually. One can do that at tearDown method using connection's extra method called clear_all_collections. Alternatively, one can use subclass of Django's django.test.TestCase: djmongo.test.TestCase.

Development

We use github for development of this package (repository, issue tracker). We also use tox for package testing against - if one would like to run whole test suite against all supported Django versions, simply clone repository and run tox command within it (pip install tox if it's missing).

(Un)license

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org/>

Something went wrong with that request. Please try again.