Database.Redis.Simple

Documentation

runRedis :: Connection -> Redis a -> IO (Either Reply a)

auth :: ByteString -> Redis Status

echo :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m ByteString

ping :: (RedisCtx mi r, WrappedRedis m mi r) => m Status

quit :: (RedisCtx mi r, WrappedRedis m mi r) => m Status

select :: (RedisCtx mi r, WrappedRedis m mi r) => Integer -> m Status

del :: (RedisCtx mi r, WrappedRedis m mi r) => [ByteString] -> m Integer

dump :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m ByteString

exists :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m Bool

expire :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> m Bool

expireAt :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> m Bool

keys :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m [ByteString]

migrate :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> ByteString -> Integer -> Integer -> m Status

move :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> m Bool

objectRefCount :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m Integer

objectEncoding :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m ByteString

objectIdleTime :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m Integer

persist :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m Bool

pExpire :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> m Bool

pExpireAt :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> m Bool

pTtl :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m Integer

randomKey :: (RedisCtx mi r, WrappedRedis m mi r) => m (Maybe ByteString)

rename :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m Status

renameNx :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m Bool

restore :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> ByteString -> m Status

sort :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> SortOpts -> m [ByteString]

sortStore :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> SortOpts -> m Integer

ttl :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m Integer

getType :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m RedisType

hDel :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [ByteString] -> m Integer

hExists :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m Bool

hGet :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m (Maybe ByteString)

hGetAll :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m [(ByteString, ByteString)]

hIncrBy :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> Integer -> m Integer

hIncrByFloat :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> Double -> m Double

hKeys :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m [ByteString]

hLen :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m Integer

hMGet :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [ByteString] -> m [Maybe ByteString]

hMSet :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [(ByteString, ByteString)] -> m Status

hSet :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> ByteString -> m Bool

hSetNX :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> ByteString -> m Bool

hVals :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m [ByteString]

blPop :: (RedisCtx mi r, WrappedRedis m mi r) => [ByteString] -> Integer -> m (Maybe (ByteString, ByteString))

brPop :: (RedisCtx mi r, WrappedRedis m mi r) => [ByteString] -> Integer -> m (Maybe (ByteString, ByteString))

brPopLPush :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> Integer -> m (Maybe ByteString)

lIndex :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> m (Maybe ByteString)

lInsertBefore :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> ByteString -> m Integer

lInsertAfter :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> ByteString -> m Integer

lLen :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m Integer

lPop :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m (Maybe ByteString)

lPush :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [ByteString] -> m Integer

lPushX :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m Integer

lRange :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> Integer -> m [ByteString]

lRem :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> ByteString -> m Integer

lSet :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> ByteString -> m Status

lTrim :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> Integer -> m Status

rPop :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m (Maybe ByteString)

rPopLPush :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m (Maybe ByteString)

rPush :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [ByteString] -> m Integer

rPushX :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m Integer

eval :: (RedisCtx mi r, WrappedRedis m mi r, RedisResult a) => ByteString -> [ByteString] -> [ByteString] -> m a

evalSha :: (RedisCtx mi r, WrappedRedis m mi r, RedisResult a) => ByteString -> [ByteString] -> [ByteString] -> m a

scriptExists :: (RedisCtx mi r, WrappedRedis m mi r) => [ByteString] -> m [Bool]

scriptFlush :: (RedisCtx mi r, WrappedRedis m mi r) => m Status

scriptKill :: (RedisCtx mi r, WrappedRedis m mi r) => m Status

scriptLoad :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m ByteString

bgRewriteAof :: (RedisCtx mi r, WrappedRedis m mi r) => m Status

bgSave :: (RedisCtx mi r, WrappedRedis m mi r) => m Status

configGet :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m [(ByteString, ByteString)]

configResetStat :: (RedisCtx mi r, WrappedRedis m mi r) => m Status

configSet :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m Status

dbSize :: (RedisCtx mi r, WrappedRedis m mi r) => m Integer

debugObject :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m ByteString

flushAll :: (RedisCtx mi r, WrappedRedis m mi r) => m Status

flushDb :: (RedisCtx mi r, WrappedRedis m mi r) => m Status

info :: (RedisCtx mi r, WrappedRedis m mi r) => m ByteString

lastSave :: (RedisCtx mi r, WrappedRedis m mi r) => m Integer

save :: (RedisCtx mi r, WrappedRedis m mi r) => m Status

slaveOf :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m Status

slowLogGet :: (RedisCtx mi r, WrappedRedis m mi r) => Integer -> m [Slowlog]

slowLogLen :: (RedisCtx mi r, WrappedRedis m mi r) => m Integer

slowLogReset :: (RedisCtx mi r, WrappedRedis m mi r) => m Status

time :: (RedisCtx mi r, WrappedRedis m mi r) => m (Integer, Integer)

sAdd :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [ByteString] -> m Integer

sCard :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m Integer

sDiff :: (RedisCtx mi r, WrappedRedis m mi r) => [ByteString] -> m [ByteString]

sDiffStore :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [ByteString] -> m Integer

sInter :: (RedisCtx mi r, WrappedRedis m mi r) => [ByteString] -> m [ByteString]

sInterStore :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [ByteString] -> m Integer

sIsMember :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m Bool

sMembers :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m [ByteString]

sMove :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> ByteString -> m Bool

sPop :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m (Maybe ByteString)

sRandMember :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m (Maybe ByteString)

sRem :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [ByteString] -> m Integer

sUnion :: (RedisCtx mi r, WrappedRedis m mi r) => [ByteString] -> m [ByteString]

sUnionStore :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [ByteString] -> m Integer

zAdd :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [(Double, ByteString)] -> m Integer

zCard :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m Integer

zCount :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Double -> Double -> m Integer

zIncrBy :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> ByteString -> m Double

zInterStore :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [ByteString] -> Aggregate -> m Integer

zInterStoreWeights :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [(ByteString, Double)] -> Aggregate -> m Integer

zRange :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> Integer -> m [ByteString]

zRangeWithScores :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> Integer -> m [(ByteString, Double)]

zRangeByScore :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Double -> Double -> m [ByteString]

zRangeByScoreWithScores :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Double -> Double -> m [(ByteString, Double)]

zRangeByScoreLimit :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Double -> Double -> Integer -> Integer -> m [ByteString]

zRangeByScoreWithScoresLimit :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Double -> Double -> Integer -> Integer -> m [(ByteString, Double)]

zRank :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m (Maybe Integer)

zRem :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [ByteString] -> m Integer

zRemRangeByRank :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> Integer -> m Integer

zRemRangeByScore :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Double -> Double -> m Integer

zRevRange :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> Integer -> m [ByteString]

zRevRangeWithScores :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> Integer -> m [(ByteString, Double)]

zRevRangeByScore :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Double -> Double -> m [ByteString]

zRevRangeByScoreWithScores :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Double -> Double -> m [(ByteString, Double)]

zRevRangeByScoreLimit :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Double -> Double -> Integer -> Integer -> m [ByteString]

zRevRangeByScoreWithScoresLimit :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Double -> Double -> Integer -> Integer -> m [(ByteString, Double)]

zRevRank :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m (Maybe Integer)

zScore :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m (Maybe Double)

zUnionStore :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [ByteString] -> Aggregate -> m Integer

zUnionStoreWeights :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [(ByteString, Double)] -> Aggregate -> m Integer

append :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m Integer

bitCount :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m Integer

bitCountRange :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> Integer -> m Integer

bitOpAnd :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [ByteString] -> m Integer

bitOpOr :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [ByteString] -> m Integer

bitOpXor :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> [ByteString] -> m Integer

bitOpNot :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m Integer

decr :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m Integer

decrBy :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> m Integer

get :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m (Maybe ByteString)

getBit :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> m Integer

getRange :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> Integer -> m ByteString

getSet :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m (Maybe ByteString)

incr :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m Integer

incrBy :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> m Integer

incrByFloat :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Double -> m Double

mGet :: (RedisCtx mi r, WrappedRedis m mi r) => [ByteString] -> m [Maybe ByteString]

mSet :: (RedisCtx mi r, WrappedRedis m mi r) => [(ByteString, ByteString)] -> m Status

mSetNx :: (RedisCtx mi r, WrappedRedis m mi r) => [(ByteString, ByteString)] -> m Bool

pSetEx :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> ByteString -> m Status

set :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m Status

setBit :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> ByteString -> m Integer

setEx :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> ByteString -> m Status

setNx :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m Bool

setRange :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> Integer -> ByteString -> m Integer

strLen :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> m Integer

watch :: [ByteString] -> Redis Status

unwatch :: Redis Status

multiExec :: RedisTx a -> Redis (TxResult a)

publish :: (RedisCtx mi r, WrappedRedis m mi r) => ByteString -> ByteString -> m Integer

pubSub :: PubSub -> (Message -> IO PubSub) -> Redis ()

sendRequest :: (RedisCtx mi r, WrappedRedis m mi r, RedisResult a) => [ByteString] -> m a

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.

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.

defaultConnectInfo :: ConnectInfo

Default information for connecting:

  connectHost           = "localhost"
  connectPort           = PortNumber 6379 -- Redis default port
  connectAuth           = Nothing         -- No password
  connectMaxConnections = 50              -- Up to 50 connections
  connectMaxIdleTime    = 30              -- Keep open for 30 seconds

data PortID

Constructors

Service String

PortNumber PortNumber

UnixSocket String

Instances

Eq PortID

Show PortID

connect :: ConnectInfo -> IO Connection

Opens a Connection to a Redis server designated by the given ConnectInfo.

data Status

Constructors

Ok

Pong

Status ByteString

Instances

Eq Status

Show Status

RedisResult Status

data ConnectionLostException

Instances

Show ConnectionLostException

Typeable ConnectionLostException

Exception ConnectionLostException

class RedisResult a where

Methods

decode :: Reply -> Either Reply a

Instances

RedisResult Bool

RedisResult Double

RedisResult Integer

RedisResult ByteString

RedisResult Slowlog

RedisResult Status

RedisResult RedisType

RedisResult Reply

(RedisResult k, RedisResult v) => RedisResult [(k, v)]

RedisResult a => RedisResult [a]

RedisResult a => RedisResult (Maybe a)

(RedisResult a, RedisResult b) => RedisResult (a, b)

data Reply

Low-level representation of replies from the Redis server.

Instances

Eq Reply

Show Reply

RedisResult Reply

RedisCtx Redis (Either Reply)

data PubSub

Encapsulates subscription changes. Use subscribe, unsubscribe, psubscribe, punsubscribe or mempty to construct a value. Combine values by using the Monoid interface, i.e. mappend and mconcat.

Instances

Eq PubSub

Monoid PubSub

data Message

Constructors

Message

Fields

msgChannel :: ByteString

msgMessage :: ByteString

PMessage

Fields

msgPattern :: ByteString

msgChannel :: ByteString

msgMessage :: ByteString

Instances

Show Message

data TxResult a

Result of a multiExec transaction.

Constructors

TxSuccess a

Transaction completed successfully. The wrapped value corresponds to the Queued value returned from the multiExec argument action.

TxAborted

Transaction aborted due to an earlier watch command.

TxError String

At least one of the commands returned an Error reply.

Instances

Eq a => Eq (TxResult a)

Show a => Show (TxResult a)

newtype Redis a

Constructors

Redis

Fields

fromRedis :: EitherT Reply Redis a

Instances

Monad Redis

Functor Redis

Applicative Redis

MonadIO Redis

newtype RedisTx a

Constructors

RedisTx

Fields

fromRedisTx :: RedisTx (Queued a)

Instances

Functor RedisTx

Applicative RedisTx