index.rst 1.08 KB
Newer Older
Étienne BERSAC's avatar
Étienne BERSAC committed
1
2
3
4
5
6
7
8
9
10
11
=============
 Dramatiq-pg
=============

Welcome to Dramatiq-pg documentation. Dramatiq-pg is a broker implementation of
Dramatiq_ backed by Postgres_ RDBMS. Dramatiq-pg is licensed under the
`PostgreSQL license`_.

Features
--------

Étienne BERSAC's avatar
Étienne BERSAC committed
12
- Super simple deployment: Single table, no ORM.
Étienne BERSAC's avatar
Étienne BERSAC committed
13
14
- Stores message payload and results as native JSONb.
- Uses LISTEN/NOTIFY to keep worker sync. No polling.
Étienne BERSAC's avatar
Étienne BERSAC committed
15
- Implements delayed task.
Étienne BERSAC's avatar
Étienne BERSAC committed
16
- Reliable thanks to Postgres MVCC.
Étienne BERSAC's avatar
Étienne BERSAC committed
17
18
19
- Self-healing: automatic purge of old messages. Automatic recovery after
  crash.
- Utility CLI for maintainance: flush, purge, stats, etc.
Étienne BERSAC's avatar
Étienne BERSAC committed
20
21
22
23
24
25
26
27


Contents
--------

- `Get Started <get-started.rst>`_
- `User Guide <user-guide.rst>`_
- `Deployment Guide <deployment-guide.rst>`_
Étienne BERSAC's avatar
Étienne BERSAC committed
28
- `API Reference <api.rst>`_
29
- `Why Postgres ? <why.rst>`_
Étienne BERSAC's avatar
Étienne BERSAC committed
30
31
32
33
34
35
36
37
38
39
40
41
42
- `Changelog <./changelog.rst>`_


Project Info
------------

- `Source Code <https://gitlab.com/dalibo/dramatiq-pg>`_
- `Issue tracker <https://gitlab.com/dalibo/dramatiq-pg/issues>`_
- `PostgreSQL License`_

.. _Dramatiq: https://dramatiq.io/
.. _Postgres: https://postgresql.org/
.. _PostgreSQL license: ../LICENSE