Safe Haskell	None
Language	GHC2021

Hasql.Pool.Extended

Synopsis

data PoolConfig = PoolConfig {
- size :: Int
- acquisitionTimeout :: Duration
- idlenessTimeout :: Duration
}
postgresqlConnectionStringWithPassword :: Map Text Text -> Maybe FilePathSecrets -> IO SecretText
data HasqlPoolMetrics = HasqlPoolMetrics {
- readyForUseGauge :: Gauge
- inUseGauge :: Gauge
- establishedCounter :: Counter
- connectionFailureCounter :: Counter
- acquisitionTimeoutCounter :: Counter
- sessionFailureCounter :: Counter
- sessionCounter :: Counter
- connectionAcquisitionDuration :: Histogram
- sessionDuration :: Histogram
}
data Pool = Pool {
- rawPool :: Pool
- metrics :: HasqlPoolMetrics
- poolAcquisitionTimeout :: Duration
}
recordHasqlPoolConnectionAcquisition :: HasqlPoolMetrics -> Double -> IO ()
recordHasqlPoolConnectionEstablished :: HasqlPoolMetrics -> IO ()
recordHasqlPoolConnectionFailure :: HasqlPoolMetrics -> IO ()
recordHasqlPoolSessionStarted :: HasqlPoolMetrics -> IO ()
recordHasqlPoolSessionFailure :: HasqlPoolMetrics -> IO ()
recordHasqlPoolSessionDuration :: HasqlPoolMetrics -> Double -> IO ()
recordHasqlPoolAcquisitionTimeout :: HasqlPoolMetrics -> IO ()
recordHasqlPoolStats :: Pool -> IO ()
startHasqlPoolStatsReporter :: Pool -> IO ()
initPostgresPool :: PoolConfig -> Map Text Text -> Maybe FilePathSecrets -> IO Pool

Documentation

data PoolConfig Source #

Constructors

PoolConfig
Fields size :: Int acquisitionTimeout :: Duration Configured pool acquisition wait time. hasql-resource-pool only accepts whole seconds here, so we round up to the nearest second and pass it through as the pool acquisition timeout. idlenessTimeout :: Duration Controls how long idle connections stay resident in the pool.

Instances

Instances details

FromJSON PoolConfig Source #
Instance details Defined in Hasql.Pool.Extended Methods parseJSON :: Value -> Parser PoolConfig Source # parseJSONList :: Value -> Parser [PoolConfig] Source # omittedField :: Maybe PoolConfig Source #
Show PoolConfig Source #
Instance details Defined in Hasql.Pool.Extended Methods showsPrec :: Int -> PoolConfig -> ShowS # show :: PoolConfig -> String # showList :: [PoolConfig] -> ShowS #
Eq PoolConfig Source #
Instance details Defined in Hasql.Pool.Extended Methods (==) :: PoolConfig -> PoolConfig -> Bool # (/=) :: PoolConfig -> PoolConfig -> Bool #

postgresqlConnectionStringWithPassword :: Map Text Text -> Maybe FilePathSecrets -> IO SecretText Source #

Render a PostgreSQL connection string in libpq key-value format.

Passwords from the optional secret file are inserted into the key-value map before rendering. The result is wrapped because it may contain the password.

data HasqlPoolMetrics Source #

Constructors

HasqlPoolMetrics
Fields readyForUseGauge :: Gauge inUseGauge :: Gauge establishedCounter :: Counter connectionFailureCounter :: Counter acquisitionTimeoutCounter :: Counter sessionFailureCounter :: Counter sessionCounter :: Counter connectionAcquisitionDuration :: Histogram sessionDuration :: Histogram

data Pool Source #

Constructors

Pool
Fields rawPool :: Pool metrics :: HasqlPoolMetrics poolAcquisitionTimeout :: Duration Pool acquisition timeout in seconds, rounded up from the configured duration. This is used by the session runner to bound waiting for an available connection slot.

recordHasqlPoolConnectionAcquisition :: HasqlPoolMetrics -> Double -> IO () Source #

recordHasqlPoolConnectionEstablished :: HasqlPoolMetrics -> IO () Source #

recordHasqlPoolConnectionFailure :: HasqlPoolMetrics -> IO () Source #

recordHasqlPoolSessionStarted :: HasqlPoolMetrics -> IO () Source #

recordHasqlPoolSessionFailure :: HasqlPoolMetrics -> IO () Source #

recordHasqlPoolSessionDuration :: HasqlPoolMetrics -> Double -> IO () Source #

recordHasqlPoolAcquisitionTimeout :: HasqlPoolMetrics -> IO () Source #

recordHasqlPoolStats :: Pool -> IO () Source #

startHasqlPoolStatsReporter :: Pool -> IO () Source #

initPostgresPool :: PoolConfig -> Map Text Text -> Maybe FilePathSecrets -> IO Pool Source #

Creates a pool from postgres config params.

acquisitionTimeout is mapped to the pool acquisition timeout, idlenessTimeout controls how long idle connections stay resident.