diff --git a/README.rst b/README.rst index b6ebb92..eef6594 100644 --- a/README.rst +++ b/README.rst @@ -20,7 +20,7 @@ Features - Django Admin integration - PaaS compatible with multiple instances - Multi cluster monitor -- Redis, Disque, IronMQ, SQS or ORM +- Redis, Disque, IronMQ, SQS, MongoDB or ORM - Python 2 and 3 Requirements @@ -39,6 +39,7 @@ Brokers - `Disque `__ - `IronMQ `__ - `Amazon SQS `__ +- `MongoDB `__ - `Django ORM `__ Installation diff --git a/docs/brokers.rst b/docs/brokers.rst index e6dffe5..8bf4db6 100644 --- a/docs/brokers.rst +++ b/docs/brokers.rst @@ -76,10 +76,12 @@ Although `SQS `__ is not the fastest, it is stable, MongoDB ------- -The +This highly scalable NoSQL database makes for a very fast and reliably persistent at-least-once message broker. +Usually available on most PaaS providers, as `open-source `__ or commercial `enterprise `__ edition. * Delivery receipts * Needs Django's `Cache framework `__ configured for monitoring +* Can be configured as the Django cache-backend through several open-source cache providers. * Requires the `pymongo `__ driver: ``pip install pymongo`` * See the :ref:`mongo_configuration` configuration section for options. @@ -94,6 +96,7 @@ However for a medium message rate and scheduled tasks, this is the most convenie * Delivery receipts * Supports bulk dequeue * Needs Django's `Cache framework `__ configured for monitoring +* Can be `configured `__ as its own cache backend. * Queue editable in Django Admin * See the :ref:`orm_configuration` configuration on how to set it up. diff --git a/docs/configure.rst b/docs/configure.rst index e3c84c5..50024dd 100644 --- a/docs/configure.rst +++ b/docs/configure.rst @@ -268,7 +268,7 @@ Set ``orm`` to the name of that database connection and make sure you run migrat mongo ~~~~~ -To use MongoDB as a message broker you simply provide the connection information in a dictionary :: +To use MongoDB as a message broker you simply provide the connection information in a dictionary:: # example MongoDB broker connection @@ -284,7 +284,7 @@ To use MongoDB as a message broker you simply provide the connection information } } -The ``mongo`` dictionary can contain any of the parameters exposed by pymongo's`MongoClient`__ +The ``mongo`` dictionary can contain any of the parameters exposed by pymongo's `MongoClient `__ mongo_db ~~~~~~~~ diff --git a/docs/index.rst b/docs/index.rst index ddb4aac..b46ba00 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,7 +20,7 @@ Features - Django Admin integration - PaaS compatible with multiple instances - Multi cluster monitor -- Redis, Disque, IronMQ, SQS or ORM +- Redis, Disque, IronMQ, SQS, MongoDB or ORM - Python 2 and 3 diff --git a/docs/install.rst b/docs/install.rst index 9fb0797..e3b4b38 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -68,10 +68,15 @@ Optional $ pip install iron-mq +- `Pymongo `__ is needed if you want to use MongoDB as a message broker:: + + $ pip install pymongo + - `Redis `__ server is the default broker for Django Q. It provides the best performance and does not require Django's cache framework for monitoring. - `Disque `__ server is based on Redis by the same author, but focuses on reliable queues. Currently in Alpha, but highly recommended. You can either build it from source or use it on Heroku through the `Tynd `__ beta. +- `MongoDB `__ is a highly scalable NoSQL database which makes for a very fast and reliably persistent at-least-once message broker. Usually available on most PaaS providers. Compatibility ------------- diff --git a/docs/tasks.rst b/docs/tasks.rst index 094913d..b1abdb3 100644 --- a/docs/tasks.rst +++ b/docs/tasks.rst @@ -79,6 +79,10 @@ a single keyword dict named ``q_options``. This enables you to use these keyword Please not that this will override any other option keywords. +.. note:: + For tasks to be processed you will need to have a worker cluster running in the background using ``python manage.py qcluster`` + or you need to configure Django Q to run in synchronous mode for testing using the :ref:`sync` option. + .. _groups: Groups