Freckle.App.Database

Database access for your App

Documentation

class Monad m => MonadTracer (m :: Type -> Type)

This is generally scoped by Monad stack to do different things

Minimal complete definition

getTracer

Instances

HasTracer app => MonadTracer (AppExample app)

Defined in Freckle.App.Test

Methods

getTracer :: AppExample app Tracer

(Monad m, HasTracer app) => MonadTracer (AppT app m)

Defined in Freckle.App

Methods

getTracer :: AppT app m Tracer

MonadTracer m => MonadTracer (IdentityT m)

Defined in OpenTelemetry.Trace.Monad

Methods

getTracer :: IdentityT m Tracer

MonadTracer m => MonadTracer (ReaderT r m)

Defined in OpenTelemetry.Trace.Monad

Methods

getTracer :: ReaderT r m Tracer

class HasStatsClient env

Minimal complete definition

statsClientL

Instances

HasStatsClient StatsClient

Defined in Freckle.App.Stats

Methods

statsClientL :: Lens' StatsClient StatsClient

HasStatsClient site => HasStatsClient (HandlerData child site)

Defined in Freckle.App.Stats

Methods

statsClientL :: Lens' (HandlerData child site) StatsClient

class HasSqlPool app where

Methods

getSqlPool :: app -> SqlPool

Instances

HasSqlPool SqlPool

Defined in Freckle.App.Database

Methods

getSqlPool :: SqlPool -> SqlPool

HasSqlPool site => HasSqlPool (HandlerData child site)

Defined in Freckle.App.Database

Methods

getSqlPool :: HandlerData child site -> SqlPool

type SqlPool = Pool SqlBackend

makePostgresPool :: (MonadUnliftIO m, MonadLoggerIO m) => m SqlPool

makePostgresPoolWith :: (MonadUnliftIO m, MonadLoggerIO m) => PostgresConnectionConf -> m SqlPool

runDB :: (MonadUnliftIO m, MonadTracer m, MonadReader app m, HasSqlPool app, HasStatsClient app, HasCallStack) => SqlPersistT m a -> m a

Run a Database action with connection stats and tracing

This uses OpenTelemetry and MonadTracer. For callstacks in traces to be useful, ensure you have HasCallStack on functions that call this (and functions that call those, for as far as you require to get to a useful source location).

runDBSimple :: (HasSqlPool app, MonadUnliftIO m, MonadReader app m) => SqlPersistT m a -> m a

data PostgresConnectionConf

Constructors

PostgresConnectionConf

Fields

• pccHost :: String
• pccPort :: Int
• pccUser :: String
• pccPassword :: PostgresPassword
• pccDatabase :: String
• pccPoolSize :: Int
• pccStatementTimeout :: PostgresStatementTimeout
• pccSchema :: Maybe String

Instances

Show PostgresConnectionConf

Defined in Freckle.App.Database

Methods

showsPrec :: Int -> PostgresConnectionConf -> ShowS

show :: PostgresConnectionConf -> String

showList :: [PostgresConnectionConf] -> ShowS

Eq PostgresConnectionConf

Defined in Freckle.App.Database

Methods

(==) :: PostgresConnectionConf -> PostgresConnectionConf -> Bool

(/=) :: PostgresConnectionConf -> PostgresConnectionConf -> Bool

data PostgresPasswordSource

Constructors

PostgresPasswordSourceIamAuth

PostgresPasswordSourceEnv

Instances

Show PostgresPasswordSource

Defined in Freckle.App.Database

Methods

showsPrec :: Int -> PostgresPasswordSource -> ShowS

show :: PostgresPasswordSource -> String

showList :: [PostgresPasswordSource] -> ShowS

Eq PostgresPasswordSource

Defined in Freckle.App.Database

Methods

(==) :: PostgresPasswordSource -> PostgresPasswordSource -> Bool

(/=) :: PostgresPasswordSource -> PostgresPasswordSource -> Bool

data PostgresPassword

Constructors

PostgresPasswordIamAuth

PostgresPasswordStatic String

Instances

Show PostgresPassword

Defined in Freckle.App.Database

Methods

showsPrec :: Int -> PostgresPassword -> ShowS

show :: PostgresPassword -> String

showList :: [PostgresPassword] -> ShowS

Eq PostgresPassword

Defined in Freckle.App.Database

Methods

(==) :: PostgresPassword -> PostgresPassword -> Bool

(/=) :: PostgresPassword -> PostgresPassword -> Bool

type PostgresStatementTimeout = Timeout

postgresStatementTimeoutMilliseconds :: PostgresStatementTimeout -> Int

envParseDatabaseConf :: PostgresPasswordSource -> Parser Error PostgresConnectionConf

envPostgresPasswordSource :: Parser Error PostgresPasswordSource