Skip to content

Commit

Permalink
Added README
Browse files Browse the repository at this point in the history
  • Loading branch information
vooft committed Aug 3, 2024
1 parent 06d78c1 commit 24c19d9
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,19 @@ Kotlin Coroutines PostgresSQL-based message queue using LISTEN/NOTIFY

Everything is String-based and for now just follows normal LISTEN/NOTIFY rules.

# Supported database SPIs
## Supported database SPIs
This library was designed to be used with different SPIs, providing similar coroutines-based interface.

Currently, only JDBC-based SPI is implemented + helper functions for jOOQ.

## JDBC
### JDBC
pg-kueue uses virtual threads to make any calls to the database in a non-blocking fashion.

It works with any `java.sql.DataSource` implementation, reserving one connection for listening to notifications.

### jOOQ
There is a module that provides a number of helper methods that can work with a jOOQ `DSLContext` and mostly delegate to the JDBC module.

# JDBC usage

## Gradle
Expand Down

0 comments on commit 24c19d9

Please sign in to comment.