Database.Persist.Redis

Documentation

newtype RedisAuth

Constructors

RedisAuth Text

Instances

Eq RedisAuth

Methods

(==) :: RedisAuth -> RedisAuth -> Bool

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

Show RedisAuth

Methods

showsPrec :: Int -> RedisAuth -> ShowS

show :: RedisAuth -> String

showList :: [RedisAuth] -> ShowS

FromJSON RedisAuth

Methods

parseJSON :: Value -> Parser RedisAuth

parseJSONList :: Value -> Parser [RedisAuth]

data RedisConf

Information required to connect to a Redis server

Constructors

RedisConf

Fields

• rdHost :: Text

  Host

• rdPort :: PortID

  Port

• rdAuth :: Maybe RedisAuth

  Auth info

• rdMaxConn :: Int

  Maximum number of connections

Instances

Show RedisConf

Methods

showsPrec :: Int -> RedisConf -> ShowS

show :: RedisConf -> String

showList :: [RedisConf] -> ShowS

PersistConfig RedisConf

Associated Types

type PersistConfigBackend RedisConf :: (* -> *) -> * -> *

type PersistConfigPool RedisConf :: *

Methods

loadConfig :: Value -> Parser RedisConf

applyEnv :: RedisConf -> IO RedisConf

createPoolConfig :: RedisConf -> IO (PersistConfigPool RedisConf)

runPool :: (MonadBaseControl IO m, MonadIO m) => RedisConf -> PersistConfigBackend RedisConf m a -> PersistConfigPool RedisConf -> m a

type PersistConfigPool RedisConf

type PersistConfigPool RedisConf = Connection

type PersistConfigBackend RedisConf

type PersistConfigBackend RedisConf = RedisT

class MonadRedis m => RedisCtx (m :: * -> *) (f :: * -> *) | m -> f

This class captures the following behaviour: In a context m, a command will return its result wrapped in a "container" of type f.

Please refer to the Command Type Signatures section of this page for more information.

Minimal complete definition

returnDecode

Instances

RedisCtx RedisTx Queued

Methods

returnDecode :: RedisResult a => Reply -> RedisTx (Queued a)

RedisCtx Redis (Either Reply)

Methods

returnDecode :: RedisResult a => Reply -> Redis (Either Reply a)

data Redis a :: * -> *

Context for normal command execution, outside of transactions. Use runRedis to run actions of this type.

In this context, each result is wrapped in an Either to account for the possibility of Redis returning an Error reply.

Instances

Monad Redis

Methods

(>>=) :: Redis a -> (a -> Redis b) -> Redis b

(>>) :: Redis a -> Redis b -> Redis b

return :: a -> Redis a

fail :: String -> Redis a

Functor Redis

Methods

fmap :: (a -> b) -> Redis a -> Redis b

(<$) :: a -> Redis b -> Redis a

Applicative Redis

Methods

pure :: a -> Redis a

(<*>) :: Redis (a -> b) -> Redis a -> Redis b

liftA2 :: (a -> b -> c) -> Redis a -> Redis b -> Redis c

(*>) :: Redis a -> Redis b -> Redis b

(<*) :: Redis a -> Redis b -> Redis a

MonadIO Redis

Methods

liftIO :: IO a -> Redis a

MonadRedis Redis

Methods

liftRedis :: Redis a -> Redis a

RedisCtx Redis (Either Reply)

Methods

returnDecode :: RedisResult a => Reply -> Redis (Either Reply a)

data Connection :: *

A threadsafe pool of network connections to a Redis server. Use the connect function to create one.

Instances

type BaseBackend Connection

type BaseBackend Connection = Connection

data BackendKey Connection

data BackendKey Connection = RedisKey Text

data PortID :: *

Constructors

Service String

PortNumber PortNumber

UnixSocket String

Instances

Eq PortID

Methods

(==) :: PortID -> PortID -> Bool

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

Show PortID

Methods

showsPrec :: Int -> PortID -> ShowS

show :: PortID -> String

showList :: [PortID] -> ShowS

type RedisT = ReaderT Connection

Monad reader transformer keeping Redis connection through out the work

runRedisPool :: RedisT m a -> Connection -> m a

withRedisConn :: (Monad m, MonadIO m) => RedisConf -> (Connection -> m a) -> m a

Run a connection reader function against a Redis configuration

thisConnection :: Monad m => RedisT m Connection

Extracts connection from RedisT monad transformer

module Database.Persist

execRedisT :: (Monad m, MonadIO m) => RedisTx (Queued a) -> RedisT m a

Execute Redis transaction inside RedisT monad transformer

type RedisBackend = Connection

data RedisException

Constructors

NotSupportedOperation String

ParserError String

NotSupportedValueType String

IncorrectUpdate String

IncorrectBehavior

Instances

Show RedisException

Methods

showsPrec :: Int -> RedisException -> ShowS

show :: RedisException -> String

showList :: [RedisException] -> ShowS

Exception RedisException

Methods

toException :: RedisException -> SomeException

fromException :: SomeException -> Maybe RedisException

displayException :: RedisException -> String