Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ChuckHend committed Aug 7, 2023
1 parent 1eb215f commit f2ce3b9
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ A lightweight distributed message queue. Like [AWS SQS](https://aws.amazon.com/s
- API parity with [AWS SQS](https://aws.amazon.com/sqs/) and [RSMQ](https://github.com/smrchy/rsmq)
- Messages stay in the queue until explicitly deleted
- Messages can be archived, instead of deleted, for long-term retention and replayability
- Table (bloat) maintenance automated with [pg_partman](https://github.com/pgpartman/pg_partman)
- High performance operations with index-only scans.

## Table of Contents
Expand Down Expand Up @@ -52,8 +51,8 @@ psql postgres://postgres:[email protected]:5432/postgres
```

```sql
-- create the extension, pg_partman is also required
CREATE EXTENSION pgmq CASCADE;
-- create the extension
CREATE EXTENSION pgmq;
```

### Creating a queue
Expand Down Expand Up @@ -199,7 +198,9 @@ pgmq=# SELECT pgmq_delete('my_queue', 3);

## Partitioned Queues

`pgmq` queue tables can be created as a paritioned table by using pgmq_create_partitioned(). [pg_partman](https://github.com/pgpartman/pg_partman/)
You will need to install [pg_partman](https://github.com/pgpartman/pg_partman/) if you want to use `pgmq` paritioned queues.

`pgmq` queue tables can be created as a partitioned table by using pgmq_create_partitioned(). [pg_partman](https://github.com/pgpartman/pg_partman/)
handles all maintenance of queue tables. This includes creating new partitions and dropping old partitions.

Partitions behavior is configured at the time queues are created, via `pgmq_create_partitioned()`. This function has a three parameters:
Expand Down

0 comments on commit f2ce3b9

Please sign in to comment.