Safe Haskell	None
Language	Haskell2010

Database.Disque

Contents

Main API
Other Commands
High level functions

Synopsis

Documentation

data Disque a Source #

Instances

Monad Disque Source #
Methods (>>=) :: Disque a -> (a -> Disque b) -> Disque b # (>>) :: Disque a -> Disque b -> Disque b # return :: a -> Disque a # fail :: String -> Disque a #
Functor Disque Source #
Methods fmap :: (a -> b) -> Disque a -> Disque b # (<$) :: a -> Disque b -> Disque a #
Applicative Disque Source #
Methods pure :: a -> Disque a # (<>) :: Disque (a -> b) -> Disque a -> Disque b # (>) :: Disque a -> Disque b -> Disque b # (<*) :: Disque a -> Disque b -> Disque a #
MonadIO Disque Source #
Methods liftIO :: IO a -> Disque a #
MonadRedis Disque Source #
Methods liftRedis :: Redis a -> Disque a #

runDisque :: Connection -> Disque a -> IO a Source #

Run disque transformer

data Connection :: * #

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

data ConnectInfo :: * #

Information for connnecting to a Redis server.

It is recommended to not use the ConnInfo data constructor directly. Instead use defaultConnectInfo and update it with record syntax. For example to connect to a password protected Redis server running on localhost and listening to the default port:

myConnectInfo :: ConnectInfo
myConnectInfo = defaultConnectInfo {connectAuth = Just "secret"}

Constructors

ConnInfo

Fields

connectHost :: HostName
connectPort :: PortID
connectAuth :: Maybe ByteString
When the server is protected by a password, set connectAuth to Just the password. Each connection will then authenticate by the auth command.
connectDatabase :: Integer
Each connection will select the database with the given index.
connectMaxConnections :: Int
Maximum number of connections to keep open. The smallest acceptable value is 1.
connectMaxIdleTime :: NominalDiffTime
Amount of time for which an unused connection is kept open. The smallest acceptable value is 0.5 seconds. If the timeout value in your redis.conf file is non-zero, it should be larger than connectMaxIdleTime.

Instances

Show ConnectInfo
Methods showsPrec :: Int -> ConnectInfo -> ShowS # show :: ConnectInfo -> String # showList :: [ConnectInfo] -> ShowS #

data Reply :: * #

Low-level representation of replies from the Redis server.

Constructors

SingleLine ByteString
Error ByteString
Integer Integer
Bulk (Maybe ByteString)
MultiBulk (Maybe [Reply])

Instances

Eq Reply
Methods (==) :: Reply -> Reply -> Bool # (/=) :: Reply -> Reply -> Bool #
Show Reply
Methods showsPrec :: Int -> Reply -> ShowS # show :: Reply -> String # showList :: [Reply] -> ShowS #
Generic Reply
Associated Types type Rep Reply :: * -> * # Methods from :: Reply -> Rep Reply x # to :: Rep Reply x -> Reply #
NFData Reply
Methods rnf :: Reply -> () #
RedisResult Reply
Methods decode :: Reply -> Either Reply Reply #
RedisCtx Redis (Either Reply)
Methods returnDecode :: RedisResult a => Reply -> Redis (Either Reply a) #
type Rep Reply
type Rep Reply = D1 (MetaData "Reply" "Database.Redis.Protocol" "hedis-0.9.8-Bl1rNEhgAqWA0oZXbmVE7p" False) ((:+:) ((:+:) (C1 (MetaCons "SingleLine" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString))) (C1 (MetaCons "Error" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString)))) ((:+:) (C1 (MetaCons "Integer" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer))) ((:+:) (C1 (MetaCons "Bulk" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ByteString)))) (C1 (MetaCons "MultiBulk" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Reply])))))))

data Job Source #

Constructors

Job
Fields queue :: Queue jobid :: JobId jobdata :: Data

Instances

Show Job Source #
Methods showsPrec :: Int -> Job -> ShowS # show :: Job -> String # showList :: [Job] -> ShowS #
RedisResult Job Source #
Methods decode :: Reply -> Either Reply Job #

type JobId = ByteString Source #

Disque job

Job IDs start with a DI and end with an SQ and are always 48 characters

disqueConnectInfo :: ConnectInfo Source #

Disque connection information

Use this smart constructor to override specifics to your client connection

e.g.

disqueConnectInfo { connectPort = PortNumber 7712 }

connect :: ConnectInfo -> IO Connection #

Constructs a Connection pool to a Redis server designated by the given ConnectInfo. The first connection is not actually established until the first call to the server.