Database.Redis

The Redis Monad

data Redis a

Instances

Monad Redis

Functor Redis

Applicative Redis

MonadIO Redis

runRedis :: RedisConn -> Redis a -> IO a

Interact with a Redis datastore specified by the given RedisConn.

May block when the given RedisConn is shared between multiple threads.

Connection

data RedisConn

Connection to a Redis server. Use the connect function to create one.

A RedisConn can only be used by a single thread at a time. This means that calls to runRedis or disconnet may block when the RedisConn is shared between multiple threads.

connect :: HostName -> PortID -> IO RedisConn

Opens a connection to a Redis server at the given host and port.

disconnect :: RedisConn -> IO ()

Close the given connection.

May block when the given RedisConn is shared between multiple threads. The RedisConn can not be re-used.

type HostName = String

Either a host name e.g., "haskell.org" or a numeric host address string consisting of a dotted decimal IPv4 address or an IPv6 address e.g., "192.168.0.1".

data PortID

Constructors

Service String

PortNumber PortNumber

UnixSocket String

defaultPort :: PortID

The Redis default port 6379. Equivalent to PortNumber 6379.

Commands

Connection

auth

Arguments

:: ByteString

password

-> Redis (Either Reply Status)

Authenticate to the server (http://redis.io/commands/auth).

echo

Arguments

:: ByteString

message

-> Redis (Either Reply ByteString)

Echo the given string (http://redis.io/commands/echo).

ping :: Redis (Either Reply Status)

Ping the server (http://redis.io/commands/ping).

quit :: Redis (Either Reply Status)

Close the connection (http://redis.io/commands/quit).

select

Arguments

:: Integer

index

-> Redis (Either Reply Status)

Change the selected database for the current connection (http://redis.io/commands/select).

Keys

del

Arguments

:: [ByteString]

key

-> Redis (Either Reply Integer)

Delete a key (http://redis.io/commands/del).

exists

Arguments

:: ByteString

key

-> Redis (Either Reply Bool)

Determine if a key exists (http://redis.io/commands/exists).

expire

Arguments

:: ByteString

key

-> Integer

seconds

-> Redis (Either Reply Bool)

Set a key's time to live in seconds (http://redis.io/commands/expire).

expireat

Arguments

:: ByteString

key

-> Integer

timestamp

-> Redis (Either Reply Bool)

Set the expiration for a key as a UNIX timestamp (http://redis.io/commands/expireat).

keys

Arguments

:: ByteString

pattern

-> Redis (Either Reply [ByteString])

Find all keys matching the given pattern (http://redis.io/commands/keys).

move

Arguments

:: ByteString

key

-> Integer

db

-> Redis (Either Reply Bool)

Move a key to another database (http://redis.io/commands/move).

objectRefcount

Arguments

:: ByteString

key

-> Redis (Either Reply Integer)

Inspect the internals of Redis objects (http://redis.io/commands/object). The Redis command OBJECT is split up into objectRefcount, objectEncoding, objectIdletime.

objectEncoding

Arguments

:: ByteString

key

-> Redis (Either Reply ByteString)

Inspect the internals of Redis objects (http://redis.io/commands/object). The Redis command OBJECT is split up into objectRefcount, objectEncoding, objectIdletime.

objectIdletime

Arguments

:: ByteString

key

-> Redis (Either Reply Integer)

Inspect the internals of Redis objects (http://redis.io/commands/object). The Redis command OBJECT is split up into objectRefcount, objectEncoding, objectIdletime.

persist

Arguments

:: ByteString

key

-> Redis (Either Reply Bool)

Remove the expiration from a key (http://redis.io/commands/persist).

randomkey :: Redis (Either Reply ByteString)

Return a random key from the keyspace (http://redis.io/commands/randomkey).

rename

Arguments

:: ByteString

key

-> ByteString

newkey

-> Redis (Either Reply Status)

Rename a key (http://redis.io/commands/rename).

renamenx

Arguments

:: ByteString

key

-> ByteString

newkey

-> Redis (Either Reply Bool)

Rename a key, only if the new key does not exist (http://redis.io/commands/renamenx).

data SortOpts

Constructors

SortOpts

Fields

sortBy :: Maybe ByteString

sortLimit :: (Integer, Integer)

sortGet :: [ByteString]

sortOrder :: SortOrder

sortAlpha :: Bool

Instances

Eq SortOpts

Show SortOpts

defaultSortOpts :: SortOpts

data SortOrder

Constructors

Asc

Desc

Instances

Eq SortOrder

Show SortOrder

sort

Arguments

:: ByteString

key

-> SortOpts

-> Redis (Either Reply [ByteString])

Sort the elements in a list, set or sorted set (http://redis.io/commands/sort). The Redis command SORT is split up into sort, sortStore.

sortStore

Arguments

:: ByteString

key

-> ByteString

destination

-> SortOpts

-> Redis (Either Reply Integer)

Sort the elements in a list, set or sorted set (http://redis.io/commands/sort). The Redis command SORT is split up into sort, sortStore.

ttl

Arguments

:: ByteString

key

-> Redis (Either Reply Integer)

Get the time to live for a key (http://redis.io/commands/ttl).

getType

Arguments

:: ByteString

key

-> Redis (Either Reply Status)

Determine the type stored at key (http://redis.io/commands/type).

Hashes

hdel

Arguments

:: ByteString

key

-> [ByteString]

field

-> Redis (Either Reply Bool)

Delete one or more hash fields (http://redis.io/commands/hdel).

hexists

Arguments

:: ByteString

key

-> ByteString

field

-> Redis (Either Reply Bool)

Determine if a hash field exists (http://redis.io/commands/hexists).

hget

Arguments

:: ByteString

key

-> ByteString

field

-> Redis (Either Reply (Maybe ByteString))

Get the value of a hash field (http://redis.io/commands/hget).

hgetall

Arguments

:: ByteString

key

-> Redis (Either Reply [(ByteString, ByteString)])

Get all the fields and values in a hash (http://redis.io/commands/hgetall).

hincrby

Arguments

:: ByteString

key

-> ByteString

field

-> Integer

increment

-> Redis (Either Reply Integer)

Increment the integer value of a hash field by the given number (http://redis.io/commands/hincrby).

hkeys

Arguments

:: ByteString

key

-> Redis (Either Reply [ByteString])

Get all the fields in a hash (http://redis.io/commands/hkeys).

hlen

Arguments

:: ByteString

key

-> Redis (Either Reply Integer)

Get the number of fields in a hash (http://redis.io/commands/hlen).

hmget

Arguments

:: ByteString

key

-> [ByteString]

field

-> Redis (Either Reply [Maybe ByteString])

Get the values of all the given hash fields (http://redis.io/commands/hmget).

hmset

Arguments

:: ByteString

key

-> [(ByteString, ByteString)]

fieldValue

-> Redis (Either Reply Status)

Set multiple hash fields to multiple values (http://redis.io/commands/hmset).

hset

Arguments

:: ByteString

key

-> ByteString

field

-> ByteString

value

-> Redis (Either Reply Bool)

Set the string value of a hash field (http://redis.io/commands/hset).

hsetnx

Arguments

:: ByteString

key

-> ByteString

field

-> ByteString

value

-> Redis (Either Reply Bool)

Set the value of a hash field, only if the field does not exist (http://redis.io/commands/hsetnx).

hvals

Arguments

:: ByteString

key

-> Redis (Either Reply [ByteString])

Get all the values in a hash (http://redis.io/commands/hvals).

Lists

blpop

Arguments

:: [ByteString]

key

-> Integer

timeout

-> Redis (Either Reply (ByteString, ByteString))

Remove and get the first element in a list, or block until one is available (http://redis.io/commands/blpop).

brpop

Arguments

:: [ByteString]

key

-> Integer

timeout

-> Redis (Either Reply (ByteString, ByteString))

Remove and get the last element in a list, or block until one is available (http://redis.io/commands/brpop).

brpoplpush

Arguments

:: ByteString

source

-> ByteString

destination

-> Integer

timeout

-> Redis (Either Reply ByteString)

Pop a value from a list, push it to another list and return it; or block until one is available (http://redis.io/commands/brpoplpush).

lindex

Arguments

:: ByteString

key

-> Integer

index

-> Redis (Either Reply ByteString)

Get an element from a list by its index (http://redis.io/commands/lindex).

linsertBefore

Arguments

:: ByteString

key

-> ByteString

pivot

-> ByteString

value

-> Redis (Either Reply Integer)

Insert an element before or after another element in a list (http://redis.io/commands/linsert). The Redis command LINSERT is split up into linsertBefore, linsertAfter.

linsertAfter

Arguments

:: ByteString

key

-> ByteString

pivot

-> ByteString

value

-> Redis (Either Reply Integer)

Insert an element before or after another element in a list (http://redis.io/commands/linsert). The Redis command LINSERT is split up into linsertBefore, linsertAfter.

llen

Arguments

:: ByteString

key

-> Redis (Either Reply Integer)

Get the length of a list (http://redis.io/commands/llen).

lpop

Arguments

:: ByteString

key

-> Redis (Either Reply ByteString)

Remove and get the first element in a list (http://redis.io/commands/lpop).

lpush

Arguments

:: ByteString

key

-> [ByteString]

value

-> Redis (Either Reply Integer)

Prepend one or multiple values to a list (http://redis.io/commands/lpush).

lpushx

Arguments

:: ByteString

key

-> ByteString

value

-> Redis (Either Reply Integer)

Prepend a value to a list, only if the list exists (http://redis.io/commands/lpushx).

lrange

Arguments

:: ByteString

key

-> Integer

start

-> Integer

stop

-> Redis (Either Reply [ByteString])

Get a range of elements from a list (http://redis.io/commands/lrange).

lrem

Arguments

:: ByteString

key

-> Integer

count

-> ByteString

value

-> Redis (Either Reply Integer)

Remove elements from a list (http://redis.io/commands/lrem).

lset

Arguments

:: ByteString

key

-> Integer

index

-> ByteString

value

-> Redis (Either Reply Status)

Set the value of an element in a list by its index (http://redis.io/commands/lset).

ltrim

Arguments

:: ByteString

key

-> Integer

start

-> Integer

stop

-> Redis (Either Reply Status)

Trim a list to the specified range (http://redis.io/commands/ltrim).

rpop

Arguments

:: ByteString

key

-> Redis (Either Reply ByteString)

Remove and get the last element in a list (http://redis.io/commands/rpop).

rpoplpush

Arguments

:: ByteString

source

-> ByteString

destination

-> Redis (Either Reply ByteString)

Remove the last element in a list, append it to another list and return it (http://redis.io/commands/rpoplpush).

rpush

Arguments

:: ByteString

key

-> [ByteString]

value

-> Redis (Either Reply Integer)

Append one or multiple values to a list (http://redis.io/commands/rpush).

rpushx

Arguments

:: ByteString

key

-> ByteString

value

-> Redis (Either Reply Integer)

Append a value to a list, only if the list exists (http://redis.io/commands/rpushx).

Server

bgrewriteaof :: Redis (Either Reply Status)

Asynchronously rewrite the append-only file (http://redis.io/commands/bgrewriteaof).

bgsave :: Redis (Either Reply Status)

Asynchronously save the dataset to disk (http://redis.io/commands/bgsave).

configGet

Arguments

:: ByteString

parameter

-> Redis (Either Reply [(ByteString, ByteString)])

Get the value of a configuration parameter (http://redis.io/commands/config-get).

configResetstat :: Redis (Either Reply Status)

Reset the stats returned by INFO (http://redis.io/commands/config-resetstat).

configSet

Arguments

:: ByteString

parameter

-> ByteString

value

-> Redis (Either Reply Status)

Set a configuration parameter to the given value (http://redis.io/commands/config-set).

dbsize :: Redis (Either Reply Integer)

Return the number of keys in the selected database (http://redis.io/commands/dbsize).

flushall :: Redis (Either Reply Status)

Remove all keys from all databases (http://redis.io/commands/flushall).

flushdb :: Redis (Either Reply Status)

Remove all keys from the current database (http://redis.io/commands/flushdb).

info :: Redis (Either Reply ByteString)

Get information and statistics about the server (http://redis.io/commands/info).

lastsave :: Redis (Either Reply Integer)

Get the UNIX time stamp of the last successful save to disk (http://redis.io/commands/lastsave).

save :: Redis (Either Reply Status)

Synchronously save the dataset to disk (http://redis.io/commands/save).

shutdown :: Redis (Either Reply Status)

Synchronously save the dataset to disk and then shut down the server (http://redis.io/commands/shutdown).

slaveof

Arguments

:: ByteString

host

-> ByteString

port

-> Redis (Either Reply Status)

Make the server a slave of another instance, or promote it as master (http://redis.io/commands/slaveof).

slowlogGet

Arguments

:: Integer

cnt

-> Redis (Either Reply Reply)

Manages the Redis slow queries log (http://redis.io/commands/slowlog). The Redis command SLOWLOG is split up into slowlogGet, slowlogLen, slowlogReset.

slowlogLen :: Redis (Either Reply Integer)

Manages the Redis slow queries log (http://redis.io/commands/slowlog). The Redis command SLOWLOG is split up into slowlogGet, slowlogLen, slowlogReset.

slowlogReset :: Redis (Either Reply Status)

Manages the Redis slow queries log (http://redis.io/commands/slowlog). The Redis command SLOWLOG is split up into slowlogGet, slowlogLen, slowlogReset.

Sets

sadd

Arguments

:: ByteString

key

-> [ByteString]

member

-> Redis (Either Reply Integer)

Add one or more members to a set (http://redis.io/commands/sadd).

scard

Arguments

:: ByteString

key

-> Redis (Either Reply Integer)

Get the number of members in a set (http://redis.io/commands/scard).

sdiff

Arguments

:: [ByteString]

key

-> Redis (Either Reply [ByteString])

Subtract multiple sets (http://redis.io/commands/sdiff).

sdiffstore

Arguments

:: ByteString

destination

-> [ByteString]

key

-> Redis (Either Reply Integer)

Subtract multiple sets and store the resulting set in a key (http://redis.io/commands/sdiffstore).

sinter

Arguments

:: [ByteString]

key

-> Redis (Either Reply [ByteString])

Intersect multiple sets (http://redis.io/commands/sinter).

sinterstore

Arguments

:: ByteString

destination

-> [ByteString]

key

-> Redis (Either Reply Integer)

Intersect multiple sets and store the resulting set in a key (http://redis.io/commands/sinterstore).

sismember

Arguments

:: ByteString

key

-> ByteString

member

-> Redis (Either Reply Bool)

Determine if a given value is a member of a set (http://redis.io/commands/sismember).

smembers

Arguments

:: ByteString

key

-> Redis (Either Reply [ByteString])

Get all the members in a set (http://redis.io/commands/smembers).

smove

Arguments

:: ByteString

source

-> ByteString

destination

-> ByteString

member

-> Redis (Either Reply Bool)

Move a member from one set to another (http://redis.io/commands/smove).

spop

Arguments

:: ByteString

key

-> Redis (Either Reply ByteString)

Remove and return a random member from a set (http://redis.io/commands/spop).

srandmember

Arguments

:: ByteString

key

-> Redis (Either Reply ByteString)

Get a random member from a set (http://redis.io/commands/srandmember).

srem

Arguments

:: ByteString

key

-> [ByteString]

member

-> Redis (Either Reply Integer)

Remove one or more members from a set (http://redis.io/commands/srem).

sunion

Arguments

:: [ByteString]

key

-> Redis (Either Reply [ByteString])

Add multiple sets (http://redis.io/commands/sunion).

sunionstore

Arguments

:: ByteString

destination

-> [ByteString]

key

-> Redis (Either Reply Integer)

Add multiple sets and store the resulting set in a key (http://redis.io/commands/sunionstore).

Sorted Sets

zadd

Arguments

:: ByteString

key

-> [(Double, ByteString)]

scoreMember

-> Redis (Either Reply Integer)

Add one or more members to a sorted set, or update its score if it already exists (http://redis.io/commands/zadd).

zcard

Arguments

:: ByteString

key

-> Redis (Either Reply Integer)

Get the number of members in a sorted set (http://redis.io/commands/zcard).

zcount

Arguments

:: ByteString

key

-> Double

min

-> Double

max

-> Redis (Either Reply Integer)

Count the members in a sorted set with scores within the given values (http://redis.io/commands/zcount).

zincrby

Arguments

:: ByteString

key

-> Integer

increment

-> ByteString

member

-> Redis (Either Reply Double)

Increment the score of a member in a sorted set (http://redis.io/commands/zincrby).

data Aggregate

Constructors

Sum

Min

Max

Instances

Eq Aggregate

Show Aggregate

zinterstore

Arguments

:: ByteString

destination

-> [ByteString]

keys

-> Aggregate

-> Redis (Either Reply Integer)

Intersect multiple sorted sets and store the resulting sorted set in a new key (http://redis.io/commands/zinterstore). The Redis command ZINTERSTORE is split up into zinterstore, zinterstoreWeights.

zinterstoreWeights

Arguments

:: ByteString

destination

-> [(ByteString, Double)]

weighted keys

-> Aggregate

-> Redis (Either Reply Integer)

Intersect multiple sorted sets and store the resulting sorted set in a new key (http://redis.io/commands/zinterstore). The Redis command ZINTERSTORE is split up into zinterstore, zinterstoreWeights.

zrange

Arguments

:: ByteString

key

-> Integer

start

-> Integer

stop

-> Redis (Either Reply [ByteString])

Return a range of members in a sorted set, by index (http://redis.io/commands/zrange). The Redis command ZRANGE is split up into zrange, zrangeWithscores.

zrangeWithscores

Arguments

:: ByteString

key

-> Integer

start

-> Integer

stop

-> Redis (Either Reply [(ByteString, Double)])

Return a range of members in a sorted set, by index (http://redis.io/commands/zrange). The Redis command ZRANGE is split up into zrange, zrangeWithscores.

zrangebyscore

Arguments

:: ByteString

key

-> Double

min

-> Double

max

-> Redis (Either Reply [ByteString])

Return a range of members in a sorted set, by score (http://redis.io/commands/zrangebyscore). The Redis command ZRANGEBYSCORE is split up into zrangebyscore, zrangebyscoreWithscores, zrangebyscoreLimit, zrangebyscoreWithscoresLimit.

zrangebyscoreWithscores

Arguments

:: ByteString

key

-> Double

min

-> Double

max

-> Redis (Either Reply [(ByteString, Double)])

Return a range of members in a sorted set, by score (http://redis.io/commands/zrangebyscore). The Redis command ZRANGEBYSCORE is split up into zrangebyscore, zrangebyscoreWithscores, zrangebyscoreLimit, zrangebyscoreWithscoresLimit.

zrangebyscoreLimit

Arguments

:: ByteString

key

-> Double

min

-> Double

max

-> Integer

offset

-> Integer

count

-> Redis (Either Reply [ByteString])

Return a range of members in a sorted set, by score (http://redis.io/commands/zrangebyscore). The Redis command ZRANGEBYSCORE is split up into zrangebyscore, zrangebyscoreWithscores, zrangebyscoreLimit, zrangebyscoreWithscoresLimit.

zrangebyscoreWithscoresLimit

Arguments

:: ByteString

key

-> Double

min

-> Double

max

-> Integer

offset

-> Integer

count

-> Redis (Either Reply [(ByteString, Double)])

Return a range of members in a sorted set, by score (http://redis.io/commands/zrangebyscore). The Redis command ZRANGEBYSCORE is split up into zrangebyscore, zrangebyscoreWithscores, zrangebyscoreLimit, zrangebyscoreWithscoresLimit.

zrank

Arguments

:: ByteString

key

-> ByteString

member

-> Redis (Either Reply Integer)

Determine the index of a member in a sorted set (http://redis.io/commands/zrank).

zrem

Arguments

:: ByteString

key

-> [ByteString]

member

-> Redis (Either Reply Integer)

Remove one or more members from a sorted set (http://redis.io/commands/zrem).

zremrangebyrank

Arguments

:: ByteString

key

-> Integer

start

-> Integer

stop

-> Redis (Either Reply Integer)

Remove all members in a sorted set within the given indexes (http://redis.io/commands/zremrangebyrank).

zremrangebyscore

Arguments

:: ByteString

key

-> Double

min

-> Double

max

-> Redis (Either Reply Integer)

Remove all members in a sorted set within the given scores (http://redis.io/commands/zremrangebyscore).

zrevrange

Arguments

:: ByteString

key

-> Integer

start

-> Integer

stop

-> Redis (Either Reply [ByteString])

Return a range of members in a sorted set, by index, with scores ordered from high to low (http://redis.io/commands/zrevrange). The Redis command ZREVRANGE is split up into zrevrange, zrevrangeWithscores.

zrevrangeWithscores

Arguments

:: ByteString

key

-> Integer

start

-> Integer

stop

-> Redis (Either Reply [(ByteString, Double)])

Return a range of members in a sorted set, by index, with scores ordered from high to low (http://redis.io/commands/zrevrange). The Redis command ZREVRANGE is split up into zrevrange, zrevrangeWithscores.

zrevrangebyscore

Arguments

:: ByteString

key

-> Double

max

-> Double

min

-> Redis (Either Reply [ByteString])

Return a range of members in a sorted set, by score, with scores ordered from high to low (http://redis.io/commands/zrevrangebyscore). The Redis command ZREVRANGEBYSCORE is split up into zrevrangebyscore, zrevrangebyscoreWithscores, zrevrangebyscoreLimit, zrevrangebyscoreWithscoresLimit.

zrevrangebyscoreWithscores

Arguments

:: ByteString

key

-> Double

max

-> Double

min

-> Redis (Either Reply [(ByteString, Double)])

Return a range of members in a sorted set, by score, with scores ordered from high to low (http://redis.io/commands/zrevrangebyscore). The Redis command ZREVRANGEBYSCORE is split up into zrevrangebyscore, zrevrangebyscoreWithscores, zrevrangebyscoreLimit, zrevrangebyscoreWithscoresLimit.

zrevrangebyscoreLimit

Arguments

:: ByteString

key

-> Double

max

-> Double

min

-> Integer

offset

-> Integer

count

-> Redis (Either Reply [ByteString])

Return a range of members in a sorted set, by score, with scores ordered from high to low (http://redis.io/commands/zrevrangebyscore). The Redis command ZREVRANGEBYSCORE is split up into zrevrangebyscore, zrevrangebyscoreWithscores, zrevrangebyscoreLimit, zrevrangebyscoreWithscoresLimit.

zrevrangebyscoreWithscoresLimit

Arguments

:: ByteString

key

-> Double

max

-> Double

min

-> Integer

offset

-> Integer

count

-> Redis (Either Reply [(ByteString, Double)])

Return a range of members in a sorted set, by score, with scores ordered from high to low (http://redis.io/commands/zrevrangebyscore). The Redis command ZREVRANGEBYSCORE is split up into zrevrangebyscore, zrevrangebyscoreWithscores, zrevrangebyscoreLimit, zrevrangebyscoreWithscoresLimit.

zrevrank

Arguments

:: ByteString

key

-> ByteString

member

-> Redis (Either Reply Integer)

Determine the index of a member in a sorted set, with scores ordered from high to low (http://redis.io/commands/zrevrank).

zscore

Arguments

:: ByteString

key

-> ByteString

member

-> Redis (Either Reply Double)

Get the score associated with the given member in a sorted set (http://redis.io/commands/zscore).

zunionstore

Arguments

:: ByteString

destination

-> [ByteString]

keys

-> Aggregate

-> Redis (Either Reply Integer)

Add multiple sorted sets and store the resulting sorted set in a new key (http://redis.io/commands/zunionstore). The Redis command ZUNIONSTORE is split up into zunionstore, zunionstoreWeights.

zunionstoreWeights

Arguments

:: ByteString

destination

-> [(ByteString, Double)]

weighted keys

-> Aggregate

-> Redis (Either Reply Integer)

Add multiple sorted sets and store the resulting sorted set in a new key (http://redis.io/commands/zunionstore). The Redis command ZUNIONSTORE is split up into zunionstore, zunionstoreWeights.

Strings

append

Arguments

:: ByteString

key

-> ByteString

value

-> Redis (Either Reply Integer)

Append a value to a key (http://redis.io/commands/append).

decr

Arguments

:: ByteString

key

-> Redis (Either Reply Integer)

Decrement the integer value of a key by one (http://redis.io/commands/decr).

decrby

Arguments

:: ByteString

key

-> Integer

decrement

-> Redis (Either Reply Integer)

Decrement the integer value of a key by the given number (http://redis.io/commands/decrby).

get

Arguments

:: ByteString

key

-> Redis (Either Reply (Maybe ByteString))

Get the value of a key (http://redis.io/commands/get).

getbit

Arguments

:: ByteString

key

-> Integer

offset

-> Redis (Either Reply Integer)

Returns the bit value at offset in the string value stored at key (http://redis.io/commands/getbit).

getrange

Arguments

:: ByteString

key

-> Integer

start

-> Integer

end

-> Redis (Either Reply ByteString)

Get a substring of the string stored at a key (http://redis.io/commands/getrange).

getset

Arguments

:: ByteString

key

-> ByteString

value

-> Redis (Either Reply (Maybe ByteString))

Set the string value of a key and return its old value (http://redis.io/commands/getset).

incr

Arguments

:: ByteString

key

-> Redis (Either Reply Integer)

Increment the integer value of a key by one (http://redis.io/commands/incr).

incrby

Arguments

:: ByteString

key

-> Integer

increment

-> Redis (Either Reply Integer)

Increment the integer value of a key by the given number (http://redis.io/commands/incrby).

mget

Arguments

:: [ByteString]

key

-> Redis (Either Reply [Maybe ByteString])

Get the values of all the given keys (http://redis.io/commands/mget).

mset

Arguments

:: [(ByteString, ByteString)]

keyValue

-> Redis (Either Reply Status)

Set multiple keys to multiple values (http://redis.io/commands/mset).

msetnx

Arguments

:: [(ByteString, ByteString)]

keyValue

-> Redis (Either Reply Bool)

Set multiple keys to multiple values, only if none of the keys exist (http://redis.io/commands/msetnx).

set

Arguments

:: ByteString

key

-> ByteString

value

-> Redis (Either Reply Status)

Set the string value of a key (http://redis.io/commands/set).

setbit

Arguments

:: ByteString

key

-> Integer

offset

-> ByteString

value

-> Redis (Either Reply Integer)

Sets or clears the bit at offset in the string value stored at key (http://redis.io/commands/setbit).

setex

Arguments

:: ByteString

key

-> Integer

seconds

-> ByteString

value

-> Redis (Either Reply Status)

Set the value and expiration of a key (http://redis.io/commands/setex).

setnx

Arguments

:: ByteString

key

-> ByteString

value

-> Redis (Either Reply Bool)

Set the value of a key, only if the key does not exist (http://redis.io/commands/setnx).

setrange

Arguments

:: ByteString

key

-> Integer

offset

-> ByteString

value

-> Redis (Either Reply Integer)

Overwrite part of a string at key starting at the specified offset (http://redis.io/commands/setrange).

strlen

Arguments

:: ByteString

key

-> Redis (Either Reply Integer)

Get the length of the value stored in a key (http://redis.io/commands/strlen).

Transactions

discard :: Redis (Either Reply Status)

Discard all commands issued after MULTI (http://redis.io/commands/discard).

exec :: Redis (Either Reply Reply)

Execute all commands issued after MULTI (http://redis.io/commands/exec).

multi :: Redis (Either Reply Status)

Mark the start of a transaction block (http://redis.io/commands/multi).

unwatch :: Redis (Either Reply Status)

Forget about all watched keys (http://redis.io/commands/unwatch).

watch

Arguments

:: [ByteString]

key

-> Redis (Either Reply Status)

Watch the given keys to determine execution of the MULTIEXEC block (<http:redis.iocommands/watch>).

Unimplemented Commands

These commands are not implemented, as of now. Library users can implement them with the sendRequest function.

• EVAL (http://redis.io/commands/eval)
• MONITOR (http://redis.io/commands/monitor)
• DEBUG OBJECT (http://redis.io/commands/debug-object)
• DEBUG SEGFAULT (http://redis.io/commands/debug-segfault)
• SYNC (http://redis.io/commands/sync)

Pub/Sub

publish

Arguments

:: ByteString

channel

-> ByteString

message

-> Redis (Either Reply Integer)

Post a message to a channel (http://redis.io/commands/publish).

pubSub

Arguments

:: PubSub

Initial subscriptions.

-> (Message -> IO PubSub)

Callback function.

-> Redis ()

Listens to published messages on subscribed channels.

The given callback function is called for each received message. Subscription changes are triggered by the returned PubSub. To keep subscriptions unchanged, the callback can return mempty.

Example: Subscribe to the "news" channel indefinitely.

  pubSub (subscribe ["news"]) $ \msg -> do
      putStrLn $ "Message from " ++ show (msgChannel msg)
      return mempty

Example: Receive a single message from the "chat" channel.

  pubSub (subscribe ["chat"]) $ \msg -> do
      putStrLn $ "Message from " ++ show (msgChannel msg)
      return $ unsubscribe ["chat"]

data Message

Constructors

Message

Fields

msgChannel :: ByteString

msgMessage :: ByteString

PMessage

Fields

msgPattern :: ByteString

msgChannel :: ByteString

msgMessage :: ByteString

Instances

Show Message

data PubSub

Instances

Monoid PubSub

subscribe

Arguments

:: [ByteString]

channel

-> PubSub

Listen for messages published to the given channels (http://redis.io/commands/subscribe).

unsubscribe

Arguments

:: [ByteString]

channel

-> PubSub

Stop listening for messages posted to the given channels (http://redis.io/commands/unsubscribe).

psubscribe

Arguments

:: [ByteString]

pattern

-> PubSub

Listen for messages published to channels matching the given patterns (http://redis.io/commands/psubscribe).

punsubscribe

Arguments

:: [ByteString]

pattern

-> PubSub

Stop listening for messages posted to channels matching the given patterns (http://redis.io/commands/punsubscribe).

Low-Level Requests and Replies

sendRequest :: RedisResult a => [ByteString] -> Redis (Either Reply a)

Sends a request to the Redis server, returning the decoded reply.

sendRequest can be used to implement one of the unimplemented commands, as shown below.

 -- |Redis DEBUG OBJECT command
 debugObject :: ByteString -> Redis (Either Reply ByteString)
 debugObject key = sendRequest ["DEBUG", "OBJECT", encode key]

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

Show Reply

RedisResult Reply

data Status

Constructors

Ok

Pong

None

String

Hash

List

Set

ZSet

Queued

Instances

Eq Status

Show Status

RedisResult Status

class RedisResult a where

Methods

decode :: Reply -> Either Reply a

Instances

RedisResult Bool

RedisResult Double

RedisResult Integer

RedisResult ByteString

RedisResult Reply

RedisResult Status

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

RedisResult a => RedisResult [a]

RedisResult a => RedisResult (Maybe a)

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