redis-io-0.6.0: Yet another redis client.

Safe HaskellNone
LanguageHaskell2010

Database.Redis.IO

Contents

Synopsis

Redis client

data Client a Source

Redis client monad.

Instances

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

Monads in which Client actions may be embedded.

Methods

liftClient :: Client a -> m a Source

Lift a computation to the Client monad.

Instances

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

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

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 Source

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 Source

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 () Source

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 Source

Connection pool.

Instances

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

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

Client and pool settings

data Settings Source

defSettings :: Settings Source

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 Source

setPort :: Word16 -> Settings -> Settings Source

setIdleTimeout :: NominalDiffTime -> Settings -> Settings Source

setMaxConnections :: Int -> Settings -> Settings Source

Maximum connections per pool stripe.

setPoolStripes :: Int -> Settings -> Settings Source

setConnectTimeout :: NominalDiffTime -> Settings -> Settings Source

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 Source

Exceptions

data ConnectionError Source

Constructors

ConnectionsBusy

All connections are in use.

ConnectionClosed

The connection has been closed unexpectedly.

ConnectTimeout

Connecting to redis server took too long.

Instances

newtype InternalError Source

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

Constructors

InternalError String 

Instances

newtype Timeout Source

A single send-receive cycle took too long.

Constructors

Timeout String 

Instances

data TransactionFailure Source

An exception thrown on transaction failures.

Constructors

TransactionAborted

A WATCHed key changed conccurrently.

TransactionDiscarded

The transaction was DISCARDed.

TransactionFailure String

Other transaction failure.

Instances

Re-exports

module Data.Redis.Command