Safe Haskell	None
Language	GHC2024

Arbiter.Simple.SimpleDb

Contents

Database Monad
Environment Creation

Description

Simple database monad for Arbiter with postgresql-simple backend.

SimpleDb has a built-in MonadArbiter instance, so you can use it directly:

import Arbiter.Core
import Arbiter.Simple

myFunction :: SimpleDb MyRegistry IO ()
myFunction = insertJob (defaultJob myPayload)

Synopsis

newtype SimpleDb (registry :: JobPayloadRegistry) (m :: Type -> Type) a = SimpleDb {
- unSimpleDb :: ReaderT (SimpleEnv registry) m a
}
data SimpleEnv (registry :: JobPayloadRegistry) = SimpleEnv {
- schema :: SchemaName
- simplePool :: SimpleConnectionPool
}
runSimpleDb :: forall (registry :: JobPayloadRegistry) m a. SimpleEnv registry -> SimpleDb registry m a -> m a
inTransaction :: forall (registry :: JobPayloadRegistry) m a. Connection -> SchemaName -> SimpleDb registry m a -> m a
createSimpleEnv :: forall (registry :: JobPayloadRegistry) m. MonadIO m => Proxy registry -> ByteString -> SchemaName -> m (SimpleEnv registry)
createSimpleEnvWithConfig :: forall (registry :: JobPayloadRegistry) m. MonadIO m => Proxy registry -> ByteString -> SchemaName -> PoolConfig -> m (SimpleEnv registry)
createSimpleEnvWithPool :: forall (registry :: JobPayloadRegistry). Proxy registry -> Pool Connection -> SchemaName -> SimpleEnv registry

Database Monad

newtype SimpleDb (registry :: JobPayloadRegistry) (m :: Type -> Type) a Source #

Simple database monad using postgresql-simple.

Constructors

SimpleDb
Fields unSimpleDb :: ReaderT (SimpleEnv registry) m a

Instances

Instances details

Monad m => MonadReader (SimpleEnv registry) (SimpleDb registry m) Source #
Instance details Defined in Arbiter.Simple.SimpleDb Methods ask :: SimpleDb registry m (SimpleEnv registry) # local :: (SimpleEnv registry -> SimpleEnv registry) -> SimpleDb registry m a -> SimpleDb registry m a # reader :: (SimpleEnv registry -> a) -> SimpleDb registry m a #
(Monad m, MonadIO m, MonadUnliftIO m) => MonadArbiter (SimpleDb registry m) Source #
Instance details Defined in Arbiter.Simple.SimpleDb Methods executeQuery :: Text -> Params -> RowCodec a -> SimpleDb registry m [a] # executeStatement :: Text -> Params -> SimpleDb registry m Int64 # withDbTransaction :: SimpleDb registry m a -> SimpleDb registry m a # runHandlerWithConnection :: Handler (SimpleDb registry m) jobs result -> jobs -> SimpleDb registry m result #
Monad m => HasSimplePool (SimpleDb registry m) Source #
Instance details Defined in Arbiter.Simple.SimpleDb Methods getSimplePool :: SimpleDb registry m SimpleConnectionPool Source # localSimplePool :: (SimpleConnectionPool -> SimpleConnectionPool) -> SimpleDb registry m a -> SimpleDb registry m a Source #
MonadIO m => MonadIO (SimpleDb registry m) Source #
Instance details Defined in Arbiter.Simple.SimpleDb Methods liftIO :: IO a -> SimpleDb registry m a #
MonadCatch m => MonadCatch (SimpleDb registry m) Source #
Instance details Defined in Arbiter.Simple.SimpleDb Methods catch :: (HasCallStack, Exception e) => SimpleDb registry m a -> (e -> SimpleDb registry m a) -> SimpleDb registry m a #
MonadMask m => MonadMask (SimpleDb registry m) Source #
Instance details Defined in Arbiter.Simple.SimpleDb Methods mask :: HasCallStack => ((forall a. SimpleDb registry m a -> SimpleDb registry m a) -> SimpleDb registry m b) -> SimpleDb registry m b # uninterruptibleMask :: HasCallStack => ((forall a. SimpleDb registry m a -> SimpleDb registry m a) -> SimpleDb registry m b) -> SimpleDb registry m b # generalBracket :: HasCallStack => SimpleDb registry m a -> (a -> ExitCase b -> SimpleDb registry m c) -> (a -> SimpleDb registry m b) -> SimpleDb registry m (b, c) #
MonadThrow m => MonadThrow (SimpleDb registry m) Source #
Instance details Defined in Arbiter.Simple.SimpleDb Methods throwM :: (HasCallStack, Exception e) => e -> SimpleDb registry m a #
Applicative m => Applicative (SimpleDb registry m) Source #
Instance details Defined in Arbiter.Simple.SimpleDb Methods pure :: a -> SimpleDb registry m a # (<>) :: SimpleDb registry m (a -> b) -> SimpleDb registry m a -> SimpleDb registry m b # liftA2 :: (a -> b -> c) -> SimpleDb registry m a -> SimpleDb registry m b -> SimpleDb registry m c # (>) :: SimpleDb registry m a -> SimpleDb registry m b -> SimpleDb registry m b # (<*) :: SimpleDb registry m a -> SimpleDb registry m b -> SimpleDb registry m a #
Functor m => Functor (SimpleDb registry m) Source #
Instance details Defined in Arbiter.Simple.SimpleDb Methods fmap :: (a -> b) -> SimpleDb registry m a -> SimpleDb registry m b # (<$) :: a -> SimpleDb registry m b -> SimpleDb registry m a #
Monad m => Monad (SimpleDb registry m) Source #
Instance details Defined in Arbiter.Simple.SimpleDb Methods (>>=) :: SimpleDb registry m a -> (a -> SimpleDb registry m b) -> SimpleDb registry m b # (>>) :: SimpleDb registry m a -> SimpleDb registry m b -> SimpleDb registry m b # return :: a -> SimpleDb registry m a #
MonadFail m => MonadFail (SimpleDb registry m) Source #
Instance details Defined in Arbiter.Simple.SimpleDb Methods fail :: String -> SimpleDb registry m a #
MonadUnliftIO m => MonadUnliftIO (SimpleDb registry m) Source #
Instance details Defined in Arbiter.Simple.SimpleDb Methods withRunInIO :: ((forall a. SimpleDb registry m a -> IO a) -> IO b) -> SimpleDb registry m b
Monad m => HasArbiterSchema (SimpleDb registry m) registry Source #
Instance details Defined in Arbiter.Simple.SimpleDb Methods getSchema :: SimpleDb registry m SchemaName #
type Handler (SimpleDb registry m) jobs result Source #
Instance details Defined in Arbiter.Simple.SimpleDb type Handler (SimpleDb registry m) jobs result = Connection -> jobs -> SimpleDb registry m result

data SimpleEnv (registry :: JobPayloadRegistry) Source #

Schema name and connection pool for SimpleDb.

Constructors

SimpleEnv
Fields schema :: SchemaName Schema name simplePool :: SimpleConnectionPool The connection pool state

Instances

Instances details

Monad m => MonadReader (SimpleEnv registry) (SimpleDb registry m) Source #
Instance details Defined in Arbiter.Simple.SimpleDb Methods ask :: SimpleDb registry m (SimpleEnv registry) # local :: (SimpleEnv registry -> SimpleEnv registry) -> SimpleDb registry m a -> SimpleDb registry m a # reader :: (SimpleEnv registry -> a) -> SimpleDb registry m a #

runSimpleDb :: forall (registry :: JobPayloadRegistry) m a. SimpleEnv registry -> SimpleDb registry m a -> m a Source #

Run a SimpleDb action with a SimpleEnv.

inTransaction Source #

Arguments

:: forall (registry :: JobPayloadRegistry) m a. Connection
-> SchemaName	Schema name
-> SimpleDb registry m a
-> m a

Run a SimpleDb action using a single postgresql-simple connection.

No pool or env is needed. The connection is pinned with transactionDepth = 1, so arbiter's withDbTransaction uses savepoints instead of issuing BEGIN. The caller is responsible for transaction lifecycle on the connection.

PG.withTransaction conn $ do
  PG.execute conn "INSERT INTO orders ..." params
  inTransaction conn "arbiter" $
    Arb.insertJob (Arb.defaultJob (ProcessOrder orderId))

Environment Creation

createSimpleEnv Source #

Arguments

:: forall (registry :: JobPayloadRegistry) m. MonadIO m
=> Proxy registry	Type-level job payload registry
-> ByteString	PostgreSQL connection string
-> SchemaName	Schema name
-> m (SimpleEnv registry)

Create a SimpleEnv with default pool settings (10 connections, 300s idle, 1 stripe). For workers, use createSimpleEnvWithConfig with poolConfigForWorkers instead.

createSimpleEnvWithConfig Source #

Arguments

:: forall (registry :: JobPayloadRegistry) m. MonadIO m
=> Proxy registry	Type-level job payload registry
-> ByteString	PostgreSQL connection string
-> SchemaName	Schema name
-> PoolConfig	Pool configuration
-> m (SimpleEnv registry)

Create a SimpleEnv with custom pool settings.

Example:

let config = PoolConfig
      { poolSize = 50
      , poolIdleTimeout = 120
      , poolStripes = Just 4
      }
env <- createSimpleEnvWithConfig (Proxy @MyRegistry) "host=localhost dbname=mydb" "arbiter" config

createSimpleEnvWithPool Source #

Arguments

:: forall (registry :: JobPayloadRegistry). Proxy registry	Type-level job payload registry
-> Pool Connection	User-provided connection pool
-> SchemaName	Schema name
-> SimpleEnv registry

Create a SimpleEnv with a user-provided connection pool