Database.Redis.IO

Redis client

data Client a

Redis client monad.

Instances

Monad Client

Functor Client

Applicative Client

MonadThrow Client

MonadCatch Client

MonadMask Client

MonadIO Client

MonadLogger Client

MonadClient Client

MonadBase IO Client

MonadBaseControl IO Client

MonadReader Pool Client

type StM Client a = StM (ReaderT Pool IO) a

class (Functor m, Applicative m, Monad m, MonadIO m, MonadCatch m) => MonadClient m where

Monads in which Client actions may be embedded.

Methods

liftClient :: Client a -> m a

Lift a computation to the Client monad.

Instances

MonadClient Client

MonadClient m => MonadClient (ReaderT r m)

MonadClient m => MonadClient (StateT s m)

MonadClient m => MonadClient (StateT s m)

MonadClient m => MonadClient (ExceptT e m)

runRedis :: MonadIO m => Pool -> Client a -> m a

stepwise :: MonadClient m => Redis IO a -> m a

Execute the given redis commands stepwise. I.e. every command is send to the server and the response fetched and parsed before the next command. A failing command which produces a RedisError will interrupt the command sequence and the error will be thrown as an exception.

pipelined :: MonadClient m => Redis IO a -> m a

Execute the given redis commands pipelined. I.e. commands are send in batches to the server and the responses are fetched and parsed after a full batch has been sent. A failing command which produces a RedisError will not prevent subsequent commands from being executed by the redis server. However the first error will be thrown as an exception.

transactional :: MonadClient m => Redis IO a -> m a

Execute the given redis commands in a Redis transaction. The commands in transactional are implicitly run within MULTI and EXEC, i.e. neither must be part of the commands. DISCARD can be used and throws TransactionAborted.

pubSub :: MonadClient m => (Maybe ByteString -> ByteString -> ByteString -> PubSub IO ()) -> PubSub IO () -> m ()

Execute the given publish/subscribe commands. The first parameter is the callback function which will be invoked with a possible pattern (if PSUBSCRIBE was used), channel, and message, once messages arrive.

Connection pool

data Pool

Connection pool.

Instances

MonadReader Pool Client

mkPool :: MonadIO m => Logger -> Settings -> m Pool

shutdown :: MonadIO m => Pool -> m ()

Client and pool settings

data Settings

defSettings :: Settings

Default settings.

• host = localhost
• port = 6379
• idle timeout = 60s
• stripes = 2
• connections per stripe = 25
• connect timeout = 5s
• send-receive timeout = 10s

setHost :: String -> Settings -> Settings

setPort :: Word16 -> Settings -> Settings

setIdleTimeout :: NominalDiffTime -> Settings -> Settings

setMaxConnections :: Int -> Settings -> Settings

Maximum connections per pool stripe.

setPoolStripes :: Int -> Settings -> Settings

setConnectTimeout :: NominalDiffTime -> Settings -> Settings

When a pool connection is opened, connect timeout is the maximum time we are willing to wait for the connection attempt to the redis server to succeed.

setSendRecvTimeout :: NominalDiffTime -> Settings -> Settings

Exceptions

data ConnectionError

Constructors

ConnectionsBusy

All connections are in use.

ConnectionClosed

The connection has been closed unexpectedly.

ConnectTimeout

Connecting to redis server took too long.

Instances

Show ConnectionError

Exception ConnectionError

newtype InternalError

General error, e.g. parsing redis responses failed.

Constructors

InternalError String

Instances

Show InternalError

Exception InternalError

newtype Timeout

A single send-receive cycle took too long.

Constructors

Timeout String

Instances

Show Timeout

Exception Timeout

data TransactionFailure

An exception thrown on transaction failures.

Constructors

TransactionAborted

A WATCHed key changed conccurrently.

TransactionDiscarded

The transaction was DISCARDed.

TransactionFailure String

Other transaction failure.

Instances

Show TransactionFailure

Exception TransactionFailure

Re-exports

module Data.Redis.Command