pgmq4s

package pgmq4s

Members list

Packages

package pgmq4s.domain

Type members

Classlikes

trait PgmqAdmin[F[_]]

Tagless-final algebra for PGMQ queue management and observability.

Tagless-final algebra for PGMQ queue management and observability.

Provides create, drop, purge, metrics, listing, and topic management operations. Create an instance via PgmqAdmin(backend) where backend is a PgmqAdminBackend[F] supplied by a database module.

Type parameters

F

effect type

Attributes

Companion
object
Source
PgmqAdmin.scala
Supertypes
class Object
trait Matchable
class Any
object PgmqAdmin

Attributes

Companion
trait
Source
PgmqAdmin.scala
Supertypes
class Object
trait Matchable
class Any
Self type
PgmqAdmin.type
trait PgmqAdminBackend[F[_]]

SPI trait for database backends. Implement this to provide a PGMQ admin backend.

SPI trait for database backends. Implement this to provide a PGMQ admin backend.

All operations work at the raw (String-level) representation. The higher-level PgmqAdmin[F] API wraps a backend instance and handles domain type conversions.

Attributes

Source
PgmqAdminBackend.scala
Supertypes
class Object
trait Matchable
class Any
trait PgmqClient[F[_]]

Tagless-final algebra for PGMQ message operations.

Tagless-final algebra for PGMQ message operations.

Provides typed send, read, pop, archive, delete, and visibility-timeout methods. Create an instance via PgmqClient(backend) where backend is a PgmqClientBackend[F] supplied by a database module (Doobie, Skunk, Anorm, Slick).

Type parameters

F

effect type

Attributes

Companion
object
Source
PgmqClient.scala
Supertypes
class Object
trait Matchable
class Any
object PgmqClient

Attributes

Companion
trait
Source
PgmqClient.scala
Supertypes
class Object
trait Matchable
class Any
Self type
PgmqClient.type
trait PgmqClientBackend[F[_]]

SPI trait for database backends. Implement this to provide a PGMQ backend.

SPI trait for database backends. Implement this to provide a PGMQ backend.

All operations work at the raw (String-level) JSON representation. The higher-level PgmqClient[F] API wraps a backend instance and handles encoding/decoding via PgmqEncoder/PgmqDecoder typeclasses.

Attributes

Source
PgmqClientBackend.scala
Supertypes
class Object
trait Matchable
class Any
trait PgmqCodec[A] extends PgmqEncoder[A], PgmqDecoder[A]

Combined PgmqEncoder and PgmqDecoder for type A.

Combined PgmqEncoder and PgmqDecoder for type A.

Attributes

Companion
object
Source
codecs.scala
Supertypes
trait PgmqDecoder[A]
trait PgmqEncoder[A]
class Object
trait Matchable
class Any
object PgmqCodec

Attributes

Companion
trait
Source
codecs.scala
Supertypes
class Object
trait Matchable
class Any
Self type
PgmqCodec.type
trait PgmqDecoder[A]

Typeclass for decoding JSON strings to values of type A. Bridge modules (e.g. pgmq4s.circe) provide given instances that derive PgmqDecoder from the library's own decoder.

Typeclass for decoding JSON strings to values of type A. Bridge modules (e.g. pgmq4s.circe) provide given instances that derive PgmqDecoder from the library's own decoder.

Attributes

Companion
object
Source
codecs.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait PgmqCodec[A]
object PgmqDecoder

Attributes

Companion
trait
Source
codecs.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait PgmqEncoder[A]

Typeclass for encoding values of type A to JSON strings. Bridge modules (e.g. pgmq4s.circe) provide given instances that derive PgmqEncoder from the library's own encoder.

Typeclass for encoding values of type A to JSON strings. Bridge modules (e.g. pgmq4s.circe) provide given instances that derive PgmqEncoder from the library's own encoder.

Attributes

Companion
object
Source
codecs.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait PgmqCodec[A]
object PgmqEncoder

Attributes

Companion
trait
Source
codecs.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait PgmqInspector[F[_]]

Tagless-final algebra for non-destructive message browsing.

Tagless-final algebra for non-destructive message browsing.

Provides paginated, sorted access to queue and archive tables without modifying message state. Create an instance via PgmqInspector(backend) where backend is a PgmqInspectorBackend[F] supplied by a database module.

Type parameters

F

effect type

Attributes

Companion
object
Source
PgmqInspector.scala
Supertypes
class Object
trait Matchable
class Any
object PgmqInspector

Attributes

Companion
trait
Source
PgmqInspector.scala
Supertypes
class Object
trait Matchable
class Any
Self type