feat(postgreSQL): add broker and backend result

README.md

@@ -29,6 +29,12 @@ or if you want to use it with [Redis]
    $ pipenv install 'remoulade[redis]'
 ```
 
+or if you want to use it with [PostgreSQL]
+
+```console
+   $ pipenv install 'remoulade[postgres]'
+```
+
 ## Quickstart
 
 1. Make sure you've got [RabbitMQ] running, then create a new file called
@@ -109,4 +115,5 @@ remoulade is licensed under the LGPL.  Please see [COPYING] and
 [COPYING]: https://github.com/wiremind/remoulade/blob/master/COPYING
 [RabbitMQ]: https://www.rabbitmq.com/
 [Redis]: https://redis.io
+[PostgreSQL]: https://www.postgresql.org/
 [user guide]: https://remoulade.readthedocs.io/en/latest/guide.html

docs/source/global.rst

@@ -85,4 +85,5 @@
 .. _gevent: http://www.gevent.org/
 .. _RabbitMQ: https://www.rabbitmq.com
 .. _Redis: https://redis.io
+.. _PostgreSQL: https://www.postgresql.org
 .. _Dramatiq: https://dramatiq.io

docs/source/guide.rst

@@ -381,7 +381,7 @@ Message Brokers
 ---------------
 
 Remoulade abstracts over the notion of a message broker and currently
-supports RabbitMQ out of the box.
+supports RabbitMQ and PostgreSQL out of the box.
 
 RabbitMQ Broker
 ^^^^^^^^^^^^^^^
@@ -398,6 +398,26 @@ execution::
   remoulade.set_broker(rabbitmq_broker)
 
 
+PostgreSQL Broker
+^^^^^^^^^^^^^^^^^
+
+To configure the PostgreSQL broker, instantiate a :class:`PostgresBroker
+<remoulade.brokers.postgres.PostgresBroker>` and set it as the global
+broker as early as possible during your program's execution::
+
+  import remoulade
+
+  from remoulade.brokers.postgres import PostgresBroker
+
+  postgres_broker = PostgresBroker(url="postgresql://remoulade@localhost:5432/remoulade")
+  remoulade.set_broker(postgres_broker)
+
+PostgresBroker stores messages in list-partitioned tables by queue name.
+Acked messages are archived for replay using the ``ack_retention`` setting
+(or ``REMOULADE_POSTGRESQL_ACK_RETENTION``) and can be requeued with
+``broker.requeue_archived(message_id, queue_name)``.
+
+
 Local Broker
 ^^^^^^^^^^^^^^^
 

docs/source/index.rst

@@ -53,6 +53,10 @@ Or if you want to use it with Redis_::
 
    $ pip install -U 'remoulade[redis]'
 
+Or if you want to use it with PostgreSQL_::
+
+   $ pip install -U 'remoulade[postgres]'
+
 Read the :doc:`guide` if you're ready to get started.
 
 

docs/source/installation.rst

@@ -14,12 +14,16 @@ To install remoulade, simply run the following command in a terminal::
 
   $ pip install -U 'remoulade[rabbitmq]'
 
-Remoulade use RabbitMQ_ as message broker.
+Remoulade supports RabbitMQ_ and PostgreSQL_ as message brokers.
 
 If you would like to use it with Redis_ to store the results then run:
 
   $ pip install -U 'remoulade[rabbitmq, redis]'
 
+If you would like to use it with PostgreSQL_ for the broker or results then run:
+
+  $ pip install -U 'remoulade[postgres]'
+
 If you don't have `pip`_ installed, check out `this guide`_.
 
 Extra Requirements
@@ -33,6 +37,7 @@ Name           Description
 =============  =======================================================================================
 ``rabbitmq``   Installs the required dependencies for using Remoulade with RabbitMQ.
 ``redis``      Installs the required dependencies for using Remoulade with Redis.
+``postgres``   Installs the required dependencies for PostgreSQL brokers or backends.
 =============  =======================================================================================
 
 If you want to install Remoulade with all available features, run::
@@ -67,5 +72,6 @@ in the cloned directory.
 
 
 .. _GitHub: https://github.com/wiremind/remoulade
+.. _PostgreSQL: https://www.postgresql.org/
 .. _pip: https://pip.pypa.io/en/stable/
 .. _this guide: http://docs.python-guide.org/en/latest/starting/installation/

docs/source/reference.rst

@@ -62,6 +62,9 @@ Brokers
 .. autoclass:: remoulade.brokers.rabbitmq.RabbitmqBroker
    :members:
    :inherited-members:
+.. autoclass:: remoulade.brokers.postgres.PostgresBroker
+   :members:
+   :inherited-members:
 .. autoclass:: remoulade.brokers.stub.StubBroker
    :members:
    :inherited-members:
@@ -133,6 +136,7 @@ Backends
 ^^^^^^^^
 
 .. autoclass:: remoulade.results.ResultBackend
+.. autoclass:: remoulade.results.backends.PostgresBackend
 .. autoclass:: remoulade.results.backends.RedisBackend
 .. autoclass:: remoulade.results.backends.StubBackend
 

examples/results/README.md

@@ -10,6 +10,7 @@ retrieve task results.
 1. Install remoulade: `pip install remoulade[rabbitmq]`
 1. In a separate terminal window, run the workers: `remoulade example`.
 1. In another terminal, run `python -m example`.
+1. For PostgreSQL, install `pip install remoulade[postgres]` and run `python -m postgres_example`.
 
 
 [docker]: https://docs.docker.com/engine/install/