Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fgribreau/postgresql-to-amqp
PostgreSQL to AMQP, forward PostgreSQL notifications to an AMQP queue.
https://github.com/fgribreau/postgresql-to-amqp
amqp amqp-queue crates events notifications pgnotify postgresql rabbitmq
Last synced: 10 days ago
JSON representation
PostgreSQL to AMQP, forward PostgreSQL notifications to an AMQP queue.
- Host: GitHub
- URL: https://github.com/fgribreau/postgresql-to-amqp
- Owner: FGRibreau
- Created: 2017-04-04T22:28:24.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-09T09:58:43.000Z (over 4 years ago)
- Last Synced: 2024-10-13T18:18:42.632Z (26 days ago)
- Topics: amqp, amqp-queue, crates, events, notifications, pgnotify, postgresql, rabbitmq
- Language: Rust
- Homepage: https://twitter.com/FGRibreau
- Size: 24.4 KB
- Stars: 30
- Watchers: 3
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# :warning: Discontinued
### @subzerocloud took inspiration from this project and built [pg-amqp-bridge](https://github.com/subzerocloud/pg-amqp-bridge) which now has more options, use it instead :+1:
---------------------------------------------------------
# 🚇 PostgreSQL to AMQP gateway
#### Forward PostgreSQL `pg_notify` notifications to an AMQP queue.
[](https://crates.io/crates/postgresql-to-amqp) [](https://crates.io/crates/postgresql-to-amqp) [](https://crates.io/crates/postgresql-to-amqp) [](https://hub.docker.com/r/fgribreau/postgresql-to-amqp) [](https://hub.docker.com/r/fgribreau/postgresql-to-amqp) [](https://hub.docker.com/r/fgribreau/postgresql-to-amqp) [](https://join.slack.com/t/fgribreau/shared_invite/zt-edpjwt2t-Zh39mDUMNQ0QOr9qOj~jrg)
==================
## ⛴ Cargo
```shell
cargo install postgresql-to-amqp
```
## 🐳 Docker
```shell
docker run --rm -it \
-e POSTGRESQL_URI=postgresql://username:[email protected]:port/database \
-e POSTGRESQL_CHANNEL=foo \
-e AMQP_URI=amqp://127.0.0.1:5672/ \
-e AMQP_QUEUE_NAME=queueName fgribreau/postgresql-to-amqp
```
## ⚙ Configuration
Configuration is done through environment variables:
- **POSTGRESQL_URI**: e.g. `postgresql://username:[email protected]:port/database`
- **POSTGRESQL_CHANNEL**: e.g. `foo`
- **AMQP_URI**: e.g. `amqp://127.0.0.1:5672/`
- **AMQP_QUEUE_NAME**: e.g. `queueName`
## 🎩 Usage
Start the forwarder:
```bash
POSTGRESQL_URI="postgresql://username:[email protected]:port/database" POSTGRESQL_CHANNEL="foo" AMQP_URI="amqp://127.0.0.1:5672/" AMQP_QUEUE_NAME="queueName" postgresql-to-amqp
```
Execute in psql:
```sql
SELECT pg_notify('foo', 'payload');
```
The forwarder will log and forward the notification to the amqp queue:
```
Forwarding Notification { process_id: 31694, channel: "foo", payload: "payload" } to queue "queueName"
```
## 👁 Philosophy
- Low memory consumption (1,9Mo)
- Single binary
- No dependency
- Predictable performance
## 🔫 Todo
I will happily accept PRs for this:
- [ ] AMQP connection string (AMQP authentication support) 👻
- [ ] Support JSON message
- [ ] Publish to exchange
- [ ] Add original channel as message property
- [ ] Add postgresql-to-amqp `version` as message property
- [ ] Let environment variables specify additional message properties
- [ ] Handle AMQP disconnection/reconnection
- [ ] Handle PostgreSQL disconnection/reconnection
- [ ] Health check route
- [ ] Metric route
- [x] Docker support
- [ ] Kubernetes support 😍
- [ ] Make a first major release with tests ☝️
## Related work
- [pgsql-listen-exchange](https://github.com/gmr/pgsql-listen-exchange) - RabbitMQ Exchange that publishes messages received from PostgreSQL Notifications