https://github.com/rlperez/pgmq-clj

A Clojure library that wraps the PGMQ extension for Postgres. It comes packaged with support connecting HikariCP and is capable of being extended.
https://github.com/rlperez/pgmq-clj
clojure clojure-library pgmq
Last synced: 9 months ago
JSON representation
A Clojure library that wraps the PGMQ extension for Postgres. It comes packaged with support connecting HikariCP and is capable of being extended.
Host: GitHub
URL: https://github.com/rlperez/pgmq-clj
Owner: rlperez
License: mit
Created: 2024-12-31T19:15:48.000Z (about 1 year ago)
Default Branch: master
Last Pushed: 2025-04-25T19:35:34.000Z (9 months ago)
Last Synced: 2025-04-29T08:56:47.694Z (9 months ago)
Topics: clojure, clojure-library, pgmq
Language: Clojure
Homepage:
Size: 95.7 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 5
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project

README

          

[![codecov](https://codecov.io/github/rlperez/pgmq-clj/graph/badge.svg?token=KIC7UP13WY)](https://codecov.io/github/rlperez/pgmq-clj)

[![checks](https://badgen.net/github/checks/rlperez/pgmq-clj)](https://github.com/rlperez/pgmq-clj/actions)

[![license](https://badgen.net/github/license/rlperez/pgmq-clj)](https://opensource.org/license/mit)

[![latest-release](https://badgen.net/github/release/rlperez/pgmq-clj)](https://github.com/rlperez/pgmq-clj/releases)

[![latest-tag](https://badgen.net/github/tag/rlperez/pgmq-clj)](https://github.com/rlperez/pgmq-clj/tags)

# pgmq-clj

A library that provides a wrapper of [PGMQ](https://github.com/tembo-io/pgmq), a [PostgreSQL](https://www.postgresql.org/) message queue implementation, making it easier to integrate into your application. As designed you can implement your own database access layer by implementing an `Adapter` conforming to a simple [protocol](https://github.com/rlperez/pgmq-clj/blob/master/src/com/thirstysink/pgmq_clj/db/adapter.clj). The provided adapter utilizes [HikariCP](https://github.com/brettwooldridge/HikariCP) and [next.jdbc](https://github.com/seancorfield/next-jdbc).

## Types of Documentation

* [Documentation](#documentation)

  This is documentation that will contain explanations of the functions as well as usage examples when appropriate. It is generated from the docstrings present in code generated by [quickdoc](https://github.com/borkdude/quickdoc). This documentation has a complete table of contents.

* [Specs](#specs)

  This project uses [clojure.spec.alpha](https://github.com/clojure/spec.alpha/) to provide a means of validating expectations. Using this project, leveraging the `clojure.spec.alpha/describe`, documentation is generated describing functions, return types, and their expected inputs. They are organized by a namespaced function name followed by the arguments of that function.

## Build Jar

This will build a jar that can be used directly in your applications.

```

# babashka

bb jar

# build tools

clj -T:build all

```

## Execute Tests

This will run all tests. Tests currently include an integration test using test containers against postgresql 15, 16, and 17.

```

# babashka

bb test

bb test coverage

bb test watch

# build tools

clj -M:test --profile test

clj -M:test --profile coverage

clj -M:test --profile watch

```

## Update Dependencies

This will update the local depencies in `deps.edn` and `bb.edn`.

```

# babashka

bb upgrade

# build tools

clj -M:upgrade

```

---

# Documentation

# Table of contents

-  [`com.thirstysink.pgmq-clj.core`](#com.thirstysink.pgmq-clj.core) 

    -  [`archive-messages`](#com.thirstysink.pgmq-clj.core/archive-messages) - Archives messages msg-ids in a queue named queue-name using a given adapter.

    -  [`create-queue`](#com.thirstysink.pgmq-clj.core/create-queue) - Create a queue named queue-name using a given adapter.

    -  [`delete-message`](#com.thirstysink.pgmq-clj.core/delete-message) - Permanently deletes message with id msg-id in the queue named queue-name using a given adapter.

    -  [`delete-message-batch`](#com.thirstysink.pgmq-clj.core/delete-message-batch) - Deletes all msg-ids messages in queue queue-name using a given adapter.

    -  [`drop-queue`](#com.thirstysink.pgmq-clj.core/drop-queue) - Drop queue named queue-name using a given adapter.

    -  [`list-queues`](#com.thirstysink.pgmq-clj.core/list-queues) - List all queues using a given adapter.

    -  [`pop-message`](#com.thirstysink.pgmq-clj.core/pop-message) - Pops one message from the queue named queue-name using a given adapter.

    -  [`read-message`](#com.thirstysink.pgmq-clj.core/read-message) - Read a quantity of messages from queue-name marking them invisible for visible_time seconds using a given adapter.

    -  [`send-message`](#com.thirstysink.pgmq-clj.core/send-message) - Send one message to a queue queue-name with a payload that will not be read for delay seconds using a given adapter.

    -  [`send-message-batch`](#com.thirstysink.pgmq-clj.core/send-message-batch) - Sends payload to the queue named queue-name as a collection of messages that cannot be read for delay seconds using a given adapter.

-  [`com.thirstysink.pgmq-clj.db.adapter`](#com.thirstysink.pgmq-clj.db.adapter) 

    -  [`Adapter`](#com.thirstysink.pgmq-clj.db.adapter/Adapter)

    -  [`close`](#com.thirstysink.pgmq-clj.db.adapter/close) - Performs database connection cleanup using this.

    -  [`execute!`](#com.thirstysink.pgmq-clj.db.adapter/execute!) - Execute a sql statement and params with 0 or more return values using this.

    -  [`execute-one!`](#com.thirstysink.pgmq-clj.db.adapter/execute-one!) - Execute a sql statement and params with 0 or 1 return values using this.

    -  [`query`](#com.thirstysink.pgmq-clj.db.adapter/query) - Query the database with a given sql, params, and return results using this.

    -  [`with-transaction`](#com.thirstysink.pgmq-clj.db.adapter/with-transaction) - Wrap a function f in a database transaction using this.

-  [`com.thirstysink.pgmq-clj.db.adapters.hikari-adapter`](#com.thirstysink.pgmq-clj.db.adapters.hikari-adapter) 

    -  [`->pgobject`](#com.thirstysink.pgmq-clj.db.adapters.hikari-adapter/->pgobject) - Transforms Clojure data to a PGobject x that contains the data as JSON.

    -  [`<-pgobject`](#com.thirstysink.pgmq-clj.db.adapters.hikari-adapter/<-pgobject) - Transform PGobject v containing json or jsonb value to Clojure data.

    -  [`ensure-pgmq-extension`](#com.thirstysink.pgmq-clj.db.adapters.hikari-adapter/ensure-pgmq-extension) - Checks the database to verify that the pgmq extension is installed using the adapter.

    -  [`make-hikari-adapter`](#com.thirstysink.pgmq-clj.db.adapters.hikari-adapter/make-hikari-adapter) - Create a new HikariAdapter instance.

-  [`com.thirstysink.pgmq-clj.instrumentation`](#com.thirstysink.pgmq-clj.instrumentation) 

    -  [`disable-instrumentation`](#com.thirstysink.pgmq-clj.instrumentation/disable-instrumentation) - Disables clojure.specs.alpha specs instrumentation.

    -  [`enable-instrumentation`](#com.thirstysink.pgmq-clj.instrumentation/enable-instrumentation) - Enables clojure.specs.alpha specs instrumentation.

    -  [`instrumentation-enabled?`](#com.thirstysink.pgmq-clj.instrumentation/instrumentation-enabled?) - A flag that indicates if instrumentation is enabled.

-  [`com.thirstysink.pgmq-clj.json`](#com.thirstysink.pgmq-clj.json) 

    -  [`->json`](#com.thirstysink.pgmq-clj.json/->json) - Returns a JSON-encoding String for the given Clojure object.

-  [`com.thirstysink.pgmq-clj.specs`](#com.thirstysink.pgmq-clj.specs) 

-----

# com.thirstysink.pgmq-clj.core

## `archive-messages`

``` clojure

(archive-messages adapter queue-name msg-ids)

```

Function.

Archives messages `msg-ids` in a queue named `queue-name` using a given `adapter`.

  This will remove the message from `queue-name` and place it in a archive table

  which is named `a_{queue-name}`.

  Example:

  (core/archive-messages adapter "test-queue" [3])

  ;; => ()

_Source


## `create-queue`

``` clojure

(create-queue adapter queue-name)

```

Function.

Create a queue named `queue-name` using a given `adapter`.

  Example:

  ```clojure

  (core/create-queue adapter "test-queue")

  ;; => nil

  ```

_Source


## `delete-message`

``` clojure

(delete-message adapter queue-name msg-id)

```

Function.

Permanently deletes message with id `msg-id` in the queue

  named `queue-name` using a given `adapter`.

  Example:

   (core/delete-message adapter "test-queue" 3)

   ;; => true

_Source


## `delete-message-batch`

``` clojure

(delete-message-batch adapter queue-name msg-ids)

```

Function.

Deletes all `msg-ids` messages in queue `queue-name` using a given `adapter`.

  Example:

  (core/delete-message-batch adapter "test-queue" [2 5 6])

  ;; => [2 5 6]

_Source


## `drop-queue`

``` clojure

(drop-queue adapter queue-name)

```

Function.

Drop queue named `queue-name` using a given `adapter`.

  Example:

  ```clojure

  (core/drop-queue adapter "test-queue-2")

  ;; => true

  ```

_Source


## `list-queues`

``` clojure

(list-queues adapter)

```

Function.

List all queues using a given `adapter`.

  Example:

  (core/list-queues adapter)

  ;; => [{:queue-name "test-queue",

    :is-partitioned false,

    :is-unlogged false,

    :created-at

    #object[java.time.Instant 0x680b0f16 "2025-03-20T01:01:42.842248Z"]}

   {:queue-name "test-queue-2",

    :is-partitioned false,

    :is-unlogged false,

    :created-at

    #object[java.time.Instant 0x45e79bdf "2025-03-20T01:01:46.292274Z"]}

   {:queue-name "test-queue-3",

    :is-partitioned false,

    :is-unlogged false,

    :created-at

    #object[java.time.Instant 0x19767429 "2025-03-20T01:01:54.665295Z"]}]

_Source


## `pop-message`

``` clojure

(pop-message adapter queue-name)

```

Function.

Pops one message from the queue named `queue-name` using a given `adapter`. The side-effect of

  this function is equivalent to reading and deleting a message. See also

  [[read-message]] and [[delete-message]].

  Example:

  (core/pop-message adapter "test-queue")

  ;; => {:msg-id 1,

         :read-ct 0,

         :enqueued-at #object[java.time.Instant 0x79684534 "2025-03-20T01:29:15.298975Z"],

         :vt #object[java.time.Instant 0x391acb50 "2025-03-20T01:30:45.300696Z"],

         :message {:user-id "0f83fbeb-345b-41ca-bbec-3bace0cff5b4", :order-count 12},

         :headers {:TENANT "b5bda77b-8283-4a6d-8de8-40a5041a60ee"}

_Source


## `read-message`

``` clojure

(read-message adapter queue-name visible_time quantity filter)

```

Function.

Read a `quantity` of messages from `queue-name` marking them invisible for

  `visible_time` seconds using a given `adapter`. This function supports the

  ability to `filter` messages received when making a read request.

  Here are some examples of how this conditional works:

  - If conditional is an empty JSON object ('{}'::jsonb), the condition always evaluates to TRUE, and all messages are considered matching.

  - If conditional is a JSON object with a single key-value pair, such as {'key': 'value'}, the condition checks if the message column contains a JSON object with the same key-value pair. For example:

  ```

  message = {'key': 'value', 'other_key': 'other_value'}: // matches

  message = {'other_key': 'other_value'}: // does not match

  ```

  - If conditional is a JSON object with multiple key-value pairs, such as {'key1': 'value1', 'key2': 'value2'}, the condition checks if the message column contains a JSON object with all the specified key-value pairs. For example:

  ```

  message = {'key1': 'value1', 'key2': 'value2', 'other_key': 'other_value'}: // matches

  message = {'key1': 'value1', 'other_key': 'other_value'}: // does not match

  ```

  Some examples of conditional JSONB values and their effects on the query:

  * `{}`: matches all messages

  * `{'type': 'error'}`: matches messages with a type key equal to 'error'

  * `{'type': 'error', 'severity': 'high'}`: matches messages with both type equal to 'error' and severity equal to 'high'

  * `{'user_id': 123}`: matches messages with a user_id key equal to 123

  Example:

  (core/read-message adapter "test-queue" 10 88 nil)

  ;; => ({:msg-id 2,

          :read-ct 1,

          :enqueued-at #object[java.time.Instant 0x5f794b3d "2025-03-21T01:14:00.831673Z"],

          :vt #object[java.time.Instant 0x3fcde164 "2025-03-21T01:15:32.988540Z"],

          :message {:user-id "0f83fbeb-345b-41ca-bbec-3bace0cff5b4", :order-count 12},

          :headers {:TENANT "b5bda77b-8283-4a6d-8de8-40a5041a60ee"}})

_Source


## `send-message`

``` clojure

(send-message adapter queue-name payload delay)

```

Function.

Send one message to a queue `queue-name` with a `payload`

  that will not be read for `delay` seconds using a given `adapter`.

  A `delay` of 0 indicates it may be read immediately.

  Example Payloads:

  - `{:data {:foo "bad"} :headers {:x-data "baz"}}`

  - `{:data "feed" :headers {:version "3"}}`

  Example:

  (core/send-message adapter "test-queue" {:data {:order-count 12 :user-id "0f83fbeb-345b-41ca-bbec-3bace0cff5b4"} :headers {:TENANT "b5bda77b-8283-4a6d-8de8-40a5041a60ee"}} 90)

  ;; => 1

_Source


## `send-message-batch`

``` clojure

(send-message-batch adapter queue-name payload delay)

```

Function.

Sends `payload` to the queue named `queue-name` as a collection of messages

  that cannot be read for `delay` seconds using a given `adapter`. The payload

  should be a sequence of valid JSON objects. See also [[send-message]].

  Example Payloads:

   - `[{:data {:foo "bar"} :headers {:x-data "bat"}}]`

   - `[{:data 10002 :headers {}} {:data "feed" :headers {:version "2"}} ]`

  Example:

  (core/send-message-batch adapter

                               "test-queue"

                               [{:data {:order-count 12 :user-id "0f83fbeb-345b-41ca-bbec-3bace0cff5b4"} :headers {:X-SESS-ID "b5bda77b-8283-4a6d-8de8-40a5041a60ee"}}

                                {:data {:order-count 12 :user-id "da04bf11-018f-45c4-908f-62c33b6e8aa6"} :headers {:X-SESS-ID "b0ef0d6a-e587-4c28-b995-1efe8cb31c9e"}}]

                               15)

  ;; => [5 6]

_Source


-----

# com.thirstysink.pgmq-clj.db.adapter

## `Adapter`

_Source


## `close`

``` clojure

(close this)

```

Function.

Performs database connection cleanup using `this`.

_Source


## `execute!`

``` clojure

(execute! this sql params)

```

Function.

Execute a `sql` statement and `params` with 0 or more return values using `this`.

_Source


## `execute-one!`

``` clojure

(execute-one! this sql params)

```

Function.

Execute a `sql` statement and `params` with 0 or 1 return values using `this`.

_Source


## `query`

``` clojure

(query this sql params)

```

Function.

Query the database with a given `sql`, `params`, and return results using `this`.

_Source


## `with-transaction`

``` clojure

(with-transaction this f)

```

Function.

Wrap a function `f` in a database transaction using `this`.

_Source


-----

# com.thirstysink.pgmq-clj.db.adapters.hikari-adapter

## `->pgobject`

``` clojure

(->pgobject x)

```

Function.

Transforms Clojure data to a PGobject `x` that contains the data as

  JSON. PGObject type defaults to `jsonb` but can be changed via

  metadata key `:pgtype`

_Source


## `<-pgobject`

``` clojure

(<-pgobject v)

```

Function.

Transform PGobject `v` containing `json` or `jsonb` value to Clojure data.

_Source


## `ensure-pgmq-extension`

``` clojure

(ensure-pgmq-extension adapter)

```

Function.

Checks the database to verify that the `pgmq` extension is installed

  using the `adapter`. If it is not then it will throw an exception.

  Example:

  (hikari/ensure-pgmq-extension adapter)

  ;; => nil

_Source


## `make-hikari-adapter`

``` clojure

(make-hikari-adapter config)

```

Function.

Create a new [`HikariAdapter`](#com.thirstysink.pgmq-clj.db.adapters.hikari-adapter/HikariAdapter) instance. The argument `config`

  provides database connection values. See https://github.com/tomekw/hikari-cp

  for additional details on the configuration options.

  | Setting           | Description                                                                                                  |

  | :---------------- | :----------------------------------------------------------------------------------------------------------- |

  | jdbc-url          | This property sets the JDBC connection URL.                                                                            |

  | username          | This property sets the default authentication username used when obtaining Connections from the underlying driver.     |

  | password          | This property sets the default authentication password used when obtaining Connections from the underlying driver.     |

  | maximum-pool-size | This property controls the maximum size that the pool is allowed to reach, including both idle and in-use connections. |

  | minimum-idle      | This property controls the minimum number of idle connections that HikariCP tries to maintain in the pool.             |

  Example:

  ```clojure

  (def adapter (hikari/make-hikari-adapter {:jdbc-url "jdbc:postgresql://0.0.0.0:5432/postgres" :username "postgres" :password "postgres"}))

  ;; => #'user/adapter

  ```

_Source


-----

# com.thirstysink.pgmq-clj.instrumentation

## `disable-instrumentation`

``` clojure

(disable-instrumentation)

(disable-instrumentation ns)

```

Function.

Disables `clojure.specs.alpha` specs instrumentation. If

  no namespace `ns` is provided it will disable instrumentation

  for [`com.thirstysink.pgmq-clj.core`](#com.thirstysink.pgmq-clj.core).

  [Learn more](https://github.com/clojure/spec.alpha)

_Source


## `enable-instrumentation`

``` clojure

(enable-instrumentation)

(enable-instrumentation ns)

```

Function.

Enables `clojure.specs.alpha` specs instrumentation. If

  no namespace `ns` is provided it will instrument

  [`com.thirstysink.pgmq-clj.core`](#com.thirstysink.pgmq-clj.core).

  [Learn more](https://github.com/clojure/spec.alpha)

_Source


## `instrumentation-enabled?`

A flag that indicates if instrumentation is enabled.

  This is determined by the value of the environment variable `PGMQCLJ_INSTRUMENTAION_ENABLED`.

  If the environment variable is set, the value will be true; otherwise, false.

_Source


-----

# com.thirstysink.pgmq-clj.json

## `->json`

Returns a JSON-encoding String for the given Clojure object. Takes an

  optional date format string that Date objects will be encoded with.

  The default date format (in UTC) is: `yyyy-MM-dd'T'HH:mm:ss'Z'`

_Source


-----

# Specs

---

### com.thirstysink.pgmq-clj.core/delete-message

```clojure

(fspec :args (cat :adapter :com.thirstysink.pgmq-clj.specs/adapter :queue-name :com.thirstysink.pgmq-clj.specs/queue-name :msg-id :com.thirstysink.pgmq-clj.specs/msg-id) :ret boolean? :fn nil)

```

#### :com.thirstysink.pgmq-clj.specs/header-key

```clojure

(or :string string? :keyword keyword?)

```

#### :com.thirstysink.pgmq-clj.specs/is-unlogged

```clojure

boolean?

```

#### :com.thirstysink.pgmq-clj.specs/vt

```clojure

(instance? java.time.Instant %)

```

#### :com.thirstysink.pgmq-clj.specs/msg-id

```clojure

(and number? pos?)

```

#### :com.thirstysink.pgmq-clj.specs/timestamp

```clojure

(instance? java.time.Instant %)

```

#### :com.thirstysink.pgmq-clj.specs/read-ct

```clojure

int?

```

---

### com.thirstysink.pgmq-clj.core/read-message

```clojure

(fspec :args (cat :adapter :com.thirstysink.pgmq-clj.specs/adapter :queue-name :com.thirstysink.pgmq-clj.specs/queue-name :visibility_time :com.thirstysink.pgmq-clj.specs/visibility_time :quantity :com.thirstysink.pgmq-clj.specs/quantity :filter :com.thirstysink.pgmq-clj.specs/json) :ret :com.thirstysink.pgmq-clj.specs/message-records :fn nil)

```

#### :clojure.spec.alpha/kvs->map

```clojure

(conformer (zipmap (map :clojure.spec.alpha/k %) (map :clojure.spec.alpha/v %)) (map (fn [[k v]] #:clojure.spec.alpha{:k k, :v v}) %))

```

#### :com.thirstysink.pgmq-clj.specs/data

```clojure

(fn [x] (or (map? x) (vector? x) (string? x) (number? x) (boolean? x) (nil? x)))

```

#### :com.thirstysink.pgmq-clj.specs/message

```clojure

(fn [x] (or (map? x) (vector? x) (string? x) (number? x) (boolean? x) (nil? x)))

```

#### :com.thirstysink.pgmq-clj.specs/msg-ids

```clojure

(coll-of :com.thirstysink.pgmq-clj.specs/msg-id)

```

---

### com.thirstysink.pgmq-clj.core/send-message-batch

```clojure

(fspec :args (cat :adapter :com.thirstysink.pgmq-clj.specs/adapter :queue-name :com.thirstysink.pgmq-clj.specs/queue-name :payload :com.thirstysink.pgmq-clj.specs/payload-objects :delay :com.thirstysink.pgmq-clj.specs/delay) :ret :com.thirstysink.pgmq-clj.specs/msg-ids :fn nil)

```

#### :com.thirstysink.pgmq-clj.specs/created-at

```clojure

(fn [x] (fn* [] (instance? java.time.Instant x)))

```

#### :com.thirstysink.pgmq-clj.specs/headers

```clojure

(nilable (map-of :com.thirstysink.pgmq-clj.specs/header-key :com.thirstysink.pgmq-clj.specs/header-value :min-count 0))

```

---

### com.thirstysink.pgmq-clj.core/archive-message

```clojure

(fspec :args (cat :adapter :com.thirstysink.pgmq-clj.specs/adapter :queue-name :com.thirstysink.pgmq-clj.specs/queue-name :msg-ids :com.thirstysink.pgmq-clj.specs/msg-ids) :ret :com.thirstysink.pgmq-clj.specs/msg-ids :fn nil)

```

#### :com.thirstysink.pgmq-clj.specs/queue-name

```clojure

valid-queue-name?

```

#### :com.thirstysink.pgmq-clj.specs/is-partitioned

```clojure

boolean?

```

---

### com.thirstysink.pgmq-clj.core/create-queue

```clojure

(fspec :args (cat :adapter :com.thirstysink.pgmq-clj.specs/adapter :queue-name :com.thirstysink.pgmq-clj.specs/queue-name) :ret nil :fn nil)

```

#### :com.thirstysink.pgmq-clj.specs/non-empty-msg-ids

```clojure

(and :com.thirstysink.pgmq-clj.specs/msg-ids (complement empty?))

```

#### :com.thirstysink.pgmq-clj.specs/queue-result

```clojure

(coll-of :com.thirstysink.pgmq-clj.specs/queue-record)

```

---

### com.thirstysink.pgmq-clj.core/pop-message

```clojure

(fspec :args (cat :adapter :com.thirstysink.pgmq-clj.specs/adapter :queue-name :com.thirstysink.pgmq-clj.specs/queue-name) :ret :com.thirstysink.pgmq-clj.specs/message-record :fn nil)

```

#### :com.thirstysink.pgmq-clj.specs/visibility_time

```clojure

(and int? (>= % 0))

```

---

### com.thirstysink.pgmq-clj.core/delete-message-batch

```clojure

(fspec :args (cat :adapter :com.thirstysink.pgmq-clj.specs/adapter :queue-name :com.thirstysink.pgmq-clj.specs/queue-name :msg-ids :com.thirstysink.pgmq-clj.specs/non-empty-msg-ids) :ret :com.thirstysink.pgmq-clj.specs/msg-ids :fn nil)

```

#### :com.thirstysink.pgmq-clj.specs/payload-objects

```clojure

(coll-of :com.thirstysink.pgmq-clj.specs/payload-object)

```

#### :com.thirstysink.pgmq-clj.specs/payload-object

```clojure

(keys :req-un [:com.thirstysink.pgmq-clj.specs/data :com.thirstysink.pgmq-clj.specs/headers])

```

#### :com.thirstysink.pgmq-clj.specs/adapter

```clojure

(satisfies? Adapter %)

```

#### :com.thirstysink.pgmq-clj.specs/delay

```clojure

int?

```

---

### com.thirstysink.pgmq-clj.core/drop-queue

```clojure

(fspec :args (cat :adapter :com.thirstysink.pgmq-clj.specs/adapter :queue-name :com.thirstysink.pgmq-clj.specs/queue-name) :ret boolean? :fn nil)

```

#### :com.thirstysink.pgmq-clj.specs/message-record

```clojure

(keys :req-un [:com.thirstysink.pgmq-clj.specs/msg-id :com.thirstysink.pgmq-clj.specs/read-ct :com.thirstysink.pgmq-clj.specs/enqueued-at :com.thirstysink.pgmq-clj.specs/vt :com.thirstysink.pgmq-clj.specs/message] :opt-un [:com.thirstysink.pgmq-clj.specs/headers])

```

---

### com.thirstysink.pgmq-clj.core/list-queues

```clojure

(fspec :args (cat :adapter :com.thirstysink.pgmq-clj.specs/adapter) :ret :com.thirstysink.pgmq-clj.specs/queue-result :fn nil)

```

#### :com.thirstysink.pgmq-clj.specs/header-value

```clojure

(or :string string? :number number? :list (coll-of (or :string string? :number number?)))

```

#### :com.thirstysink.pgmq-clj.specs/enqueued-at

```clojure

(instance? java.time.Instant %)

```

#### :com.thirstysink.pgmq-clj.specs/json

```clojure

(fn [x] (or (map? x) (vector? x) (string? x) (number? x) (boolean? x) (nil? x)))

```

---

### com.thirstysink.pgmq-clj.core/send-message

```clojure

(fspec :args (cat :adapter :com.thirstysink.pgmq-clj.specs/adapter :queue-name :com.thirstysink.pgmq-clj.specs/queue-name :payload :com.thirstysink.pgmq-clj.specs/payload-object :delay :com.thirstysink.pgmq-clj.specs/delay) :ret :com.thirstysink.pgmq-clj.specs/msg-id :fn nil)

```

#### :com.thirstysink.pgmq-clj.specs/queue-record

```clojure

(keys :req-un [:com.thirstysink.pgmq-clj.specs/queue-name :com.thirstysink.pgmq-clj.specs/is-partitioned :com.thirstysink.pgmq-clj.specs/is-unlogged :com.thirstysink.pgmq-clj.specs/created-at])

```

#### :com.thirstysink.pgmq-clj.specs/quantity

```clojure

(and int? (> % 0))

```

#### :com.thirstysink.pgmq-clj.specs/message-records

```clojure

(coll-of :com.thirstysink.pgmq-clj.specs/mesage-record)

```
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/rlperez/pgmq-clj

Awesome Lists containing this project

README
