Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mention pgmq_drop_queue in README #34

Merged
merged 1 commit into from
Aug 9, 2023
Merged

Mention pgmq_drop_queue in README #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 27 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ A lightweight distributed message queue. Like [AWS SQS](https://aws.amazon.com/s
- [Pop a message](#pop-a-message)
- [Archive a message](#archive-a-message)
- [Delete a message](#delete-a-message)
- [Drop a queue](#drop-a-queue)
- [Configuration](#configuration)
- [Partitioned Queues](#partitioned-queues)
- [Visibility Timeout (vt)](#visibility-timeout-vt)
Expand Down Expand Up @@ -76,38 +77,38 @@ SELECT pgmq_create('my_queue');
```

```text
pgmq_create
pgmq_create
-------------

(1 row)
```

### Send two messages

```sql
-- messages are sent as JSON
pgmq=#
pgmq=#
SELECT * from pgmq_send('my_queue', '{"foo": "bar1"}');
SELECT * from pgmq_send('my_queue', '{"foo": "bar2"}');
```

The message id is returned from the send function.

```text
pgmq_send
pgmq_send
-----------
1
(1 row)

pgmq_send
pgmq_send
-----------
2
(1 row)
```

### Read messages

Read `2` message from the queue. Make them invisible for `30` seconds.
Read `2` message from the queue. Make them invisible for `30` seconds.
If the messages are not deleted or archived within 30 seconds, they will become visible again
and can be read by another consumer.

Expand Down Expand Up @@ -157,7 +158,7 @@ pgmq=# SELECT * from pgmq_archive('my_queue', 2);
```

```text
pgmq_archive
pgmq_archive
--------------
t
(1 row)
Expand All @@ -168,7 +169,7 @@ pgmq=# SELECT * from pgmq_my_queue_archive;
```

```text
msg_id | read_ct | enqueued_at | deleted_at | vt | message
msg_id | read_ct | enqueued_at | deleted_at | vt | message
--------+---------+------------------------------+-------------------------------+-------------------------------+-----------------
2 | 1 | 2023-04-25 00:55:40.68417-05 | 2023-04-25 00:56:35.937594-05 | 2023-04-25 00:56:20.532012-05 | {"foo": "bar2"}```
```
Expand All @@ -182,7 +183,7 @@ pgmq=# SELECT * from pgmq_send('my_queue', '{"foo": "bar3"}');
```

```text
pgmq_send
pgmq_send
-----------
3
(1 row)
Expand All @@ -195,12 +196,27 @@ pgmq=# SELECT pgmq_delete('my_queue', 3);
```

```text
pgmq_delete
pgmq_delete
-------------
t
(1 row)
```

### Drop a queue

Delete the queue `my_queue`.

```sql
pgmq=# SELECT pgmq_drop_queue('my_queue');
```

```text
pgmq_drop_queue
-----------------
t
(1 row)
```

# Configuration

## Partitioned Queues
Expand All @@ -222,7 +238,7 @@ Partitions behavior is configured at the time queues are created, via `pgmq_crea


In order for automatic partition maintenance to take place, several settings must be added to the `postgresql.conf` file, which is typically located in the postgres `DATADIR`.
`pg_partman_bgw.interval`
`pg_partman_bgw.interval`
in `postgresql.conf`. Below are the default configuration values set in Tembo docker images.

Add the following to `postgresql.conf`. Note, changing `shared_preload_libraries` requires a restart of Postgres.
Expand Down
Loading