arbiter-core-0.1.0.0

arbiter-core

Safe Haskell	None
Language	GHC2024

Arbiter.Core.Queues

Description

Internal to the arbiter packages. Not covered by the PVP.

Types and DDL for the arbiter_queues table. One row per queue, scoped to the schema. Holds operator-facing per-queue state (pause flag, DLQ retention, metadata). Migrations add a row for every queue they create. Maintenance reads the table to find the schema's queues.

Synopsis

data QueueRow = QueueRow {
- queueName :: Text
- paused :: Bool
- pausedAt :: Maybe UTCTime
- metadata :: Maybe Value
- createdAt :: UTCTime
- updatedAt :: UTCTime
- dlqRetention :: Maybe NominalDiffTime
}
arbiterQueuesTable :: SchemaName -> Text
arbiterQueuesTableName :: Text
createQueuesTableSQL :: SchemaName -> Text
addDLQRetentionColumnSQL :: SchemaName -> Text
registerQueuesSQL :: SchemaName -> Text

Documentation

data QueueRowSource #

A row of the arbiter_queues table.

Constructors

Fields

queueName :: Text
The queue's table name.
paused :: Bool
Whether the queue is paused.
pausedAt :: Maybe UTCTime
When the queue was paused. Nothing while it runs.
metadata :: Maybe Value
Free-form metadata.
createdAt :: UTCTime
When the row was created.
updatedAt :: UTCTime
When the row last changed.
dlqRetention :: Maybe NominalDiffTime
Age in seconds at which the reaper purges the queue's DLQ jobs. Nothing keeps them.

Instances

Instances details

FromJSON QueueRow Source #

Instance details

Defined in Arbiter.Core.Queues

Methods

parseJSON :: Value -> Parser QueueRow#

parseJSONList :: Value -> Parser [QueueRow]#

omittedField :: Maybe QueueRow#

ToJSON QueueRow Source #

Instance details

Defined in Arbiter.Core.Queues

Methods

toJSON :: QueueRow -> Value#

toEncoding :: QueueRow -> Encoding#

toJSONList :: [QueueRow] -> Value#

toEncodingList :: [QueueRow] -> Encoding#

omitField :: QueueRow -> Bool#

Eq QueueRow Source #

Instance details

Defined in Arbiter.Core.Queues

Methods

(==) :: QueueRow -> QueueRow -> Bool#

(/=) :: QueueRow -> QueueRow -> Bool#

Generic QueueRow Source #

Instance details

Defined in Arbiter.Core.Queues

Associated Types

type Rep QueueRow

Instance details

Defined in Arbiter.Core.Queues

type Rep QueueRow = D1 ('MetaData "QueueRow" "Arbiter.Core.Queues" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "QueueRow" 'PrefixI 'True) ((S1 ('MetaSel ('Just "queueName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "paused") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "pausedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe UTCTime)))) :*: ((S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)) :*: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "dlqRetention") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe NominalDiffTime))))))

Methods

from :: QueueRow -> Rep QueueRow x#

to :: Rep QueueRow x -> QueueRow#

Show QueueRow Source #

Instance details

Defined in Arbiter.Core.Queues

Methods

showsPrec :: Int -> QueueRow -> ShowS#

show :: QueueRow -> String#

showList :: [QueueRow] -> ShowS#

type Rep QueueRow Source #

Instance details

Defined in Arbiter.Core.Queues

type Rep QueueRow = D1 ('MetaData "QueueRow" "Arbiter.Core.Queues" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "QueueRow" 'PrefixI 'True) ((S1 ('MetaSel ('Just "queueName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "paused") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "pausedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe UTCTime)))) :*: ((S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)) :*: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "dlqRetention") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe NominalDiffTime))))))

arbiterQueuesTable :: SchemaName -> TextSource #

Qualified table name for the arbiter_queues table.

arbiterQueuesTableName :: TextSource #

Bare name of the queues table, for catalog lookups by relname.

createQueuesTableSQL :: SchemaName -> TextSource #

DDL for the arbiter_queues table.

addDLQRetentionColumnSQL :: SchemaName -> TextSource #

Idempotent migration adding the dlq_retention_secs column. A retention must be positive.

registerQueuesSQL :: SchemaName -> TextSource #

Add a row with defaults for each queue in the one text[] parameter. Rows that exist are left alone.