Safe Haskell	Safe-Infered

Database.Redis

Contents

How To Use This Module
- Automatic Pipelining
- Error Behavior
The Redis Monad
Connection
Commands
Unimplemented Commands
Pub/Sub
Low-Level Command API

Synopsis

How To Use This Module

Connect to a Redis server:

 -- connects to localhost:6379
 conn <- connect defaultConnectInfo

Send commands to the server:

 runRedis conn $ do
      set "hello" "hello"
      set "world" "world"
      hello <- get "hello"
      world <- get "world"
      liftIO $ print (hello,world)

Automatic Pipelining

Commands are automatically pipelined as much as possible. For example, in the above "hello world" example, all four commands are pipelined. Automatic pipelining makes use of Haskell's laziness. As long as a previous reply is not evaluated, subsequent commands can be pipelined.

Automatic pipelining also works across several calls to runRedis, as long as replies are only evaluated outside the runRedis block.

To keep memory usage low, the number of requests "in the pipeline" is limited (per connection) to 1000. After that number, the next command is sent only when at least one reply has been received. That means, command functions may block until there are less than 1000 outstanding replies.

Error Behavior

Operations against keys holding the wrong kind of value:: If the Redis server returns an Error, command functions will return Left the Reply. The library user can inspect the error message to gain information on what kind of error occured.
Connection to the server lost:: In case of a lost connection, command functions throw a ConnectionLostException. It can only be caught outside of runRedis, to make sure the connection pool can properly destroy the connection.

The Redis Monad

data Redis a Source

All Redis commands run in the Redis monad.

Instances

Monad Redis
Functor Redis
Applicative Redis
MonadIO Redis

runRedis :: Connection -> Redis a -> IO aSource

Interact with a Redis datastore specified by the given Connection.

Each call of runRedis takes a network connection from the Connection pool and runs the given Redis action. Calls to runRedis may thus block while all connections from the pool are in use.

Connection

data Connection Source

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

connect :: ConnectInfo -> IO Connection Source

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

data ConnectInfo Source

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.

defaultConnectInfo :: ConnectInfo Source

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

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

Commands

Connection

auth Source

Arguments

:: ByteString	password
-> Redis (Either Reply Status)

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

echo Source

Arguments

:: ByteString	message
-> Redis (Either Reply ByteString)

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

ping :: Redis (Either Reply Status)Source

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

quit :: Redis (Either Reply Status)Source

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

select Source

Arguments

:: Integer	index
-> Redis (Either Reply Status)

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

Keys

del Source

Arguments

:: [ByteString]	key
-> Redis (Either Reply Integer)

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

exists Source

Arguments

:: ByteString	key
-> Redis (Either Reply Bool)

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

expire Source

Arguments

:: ByteString	key
-> Integer	seconds
-> Redis (Either Reply Bool)

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

expireat Source

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 Source

Arguments

:: ByteString	pattern
-> Redis (Either Reply [ByteString])

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

move Source

Arguments

:: ByteString	key
-> Integer	db
-> Redis (Either Reply Bool)

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

objectRefcount Source

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 Source

Arguments

:: ByteString	key
-> Redis (Either Reply (Maybe ByteString))

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

objectIdletime Source

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 Source

Arguments

:: ByteString	key
-> Redis (Either Reply Bool)

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

randomkey :: Redis (Either Reply (Maybe ByteString))Source

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

rename Source

Arguments

:: ByteString	key
-> ByteString	newkey
-> Redis (Either Reply Status)

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

renamenx Source

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 Source

Options for the sort command.

Constructors

SortOpts
Fields sortBy :: Maybe ByteString sortLimit :: (Integer, Integer) sortGet :: [ByteString] sortOrder :: SortOrder sortAlpha :: Bool

Instances

Eq SortOpts
Show SortOpts

defaultSortOpts :: SortOpts Source

Redis default SortOpts. Equivalent to omitting all optional parameters.

 SortOpts
     { sortBy    = Nothing -- omit the BY option
     , sortLimit = (0,-1)  -- return entire collection
     , sortGet   = []      -- omit the GET option
     , sortOrder = Asc     -- sort in ascending order
     , sortAlpha = False   -- sort numerically, not lexicographically
     }

data SortOrder Source

Constructors

Asc
Desc

Instances

Eq SortOrder
Show SortOrder

sort Source

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 Source

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 Source

Arguments

:: ByteString	key
-> Redis (Either Reply Integer)

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

getType Source

Arguments

:: ByteString	key
-> Redis (Either Reply Status)

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

Hashes

hdel Source

Arguments

:: ByteString	key
-> [ByteString]	field
-> Redis (Either Reply Bool)

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

hexists Source

Arguments

:: ByteString	key
-> ByteString	field
-> Redis (Either Reply Bool)

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

hget Source

Arguments

:: ByteString	key
-> ByteString	field
-> Redis (Either Reply (Maybe ByteString))

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

hgetall Source

Arguments

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

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

hincrby Source

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 Source

Arguments

:: ByteString	key
-> Redis (Either Reply [ByteString])

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

hlen Source

Arguments

:: ByteString	key
-> Redis (Either Reply Integer)

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

hmget Source

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 Source

Arguments

:: ByteString	key
-> [(ByteString, ByteString)]	fieldValue
-> Redis (Either Reply Status)

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

hset Source

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 Source

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 Source

Arguments

:: ByteString	key
-> Redis (Either Reply [ByteString])

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

Lists

blpop Source

Arguments

:: [ByteString]	key
-> Integer	timeout
-> Redis (Either Reply (Maybe (ByteString, ByteString)))

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

brpop Source

Arguments

:: [ByteString]	key
-> Integer	timeout
-> Redis (Either Reply (Maybe (ByteString, ByteString)))

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

brpoplpush Source

Arguments

:: ByteString	source
-> ByteString	destination
-> Integer	timeout
-> Redis (Either Reply (Maybe 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 Source

Arguments

:: ByteString	key
-> Integer	index
-> Redis (Either Reply (Maybe ByteString))

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

linsertBefore Source

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 Source

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 Source

Arguments

:: ByteString	key
-> Redis (Either Reply Integer)

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

lpop Source

Arguments

:: ByteString	key
-> Redis (Either Reply (Maybe ByteString))

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

lpush Source

Arguments

:: ByteString	key
-> [ByteString]	value
-> Redis (Either Reply Integer)

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

lpushx Source

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 Source

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 Source

Arguments

:: ByteString	key
-> Integer	count
-> ByteString	value
-> Redis (Either Reply Integer)

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

lset Source

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 Source

Arguments

:: ByteString	key
-> Integer	start
-> Integer	stop
-> Redis (Either Reply Status)

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

rpop Source

Arguments

:: ByteString	key
-> Redis (Either Reply (Maybe ByteString))

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

rpoplpush Source

Arguments

:: ByteString	source
-> ByteString	destination
-> Redis (Either Reply (Maybe ByteString))

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

rpush Source

Arguments

:: ByteString	key
-> [ByteString]	value
-> Redis (Either Reply Integer)

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

rpushx Source

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

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

bgsave :: Redis (Either Reply Status)Source

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

configGet Source

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

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

configSet Source

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

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

debugObject Source

Arguments

:: ByteString	key
-> Redis (Either Reply ByteString)

Get debugging information about a key (http://redis.io/commands/debug-object).

debugSegfault :: Redis (Either Reply Status)Source

Make the server crash (http://redis.io/commands/debug-segfault).

flushall :: Redis (Either Reply Status)Source

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

flushdb :: Redis (Either Reply Status)Source

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

info :: Redis (Either Reply ByteString)Source

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

lastsave :: Redis (Either Reply Integer)Source

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

save :: Redis (Either Reply Status)Source

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

shutdown :: Redis (Either Reply Status)Source

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

slaveof Source

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 Source

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

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

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

Sets

sadd Source

Arguments

:: ByteString	key
-> [ByteString]	member
-> Redis (Either Reply Integer)

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

scard Source

Arguments

:: ByteString	key
-> Redis (Either Reply Integer)

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

sdiff Source

Arguments

:: [ByteString]	key
-> Redis (Either Reply [ByteString])

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

sdiffstore Source

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 Source

Arguments

:: [ByteString]	key
-> Redis (Either Reply [ByteString])

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

sinterstore Source

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 Source

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 Source

Arguments

:: ByteString	key
-> Redis (Either Reply [ByteString])

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

smove Source

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 Source

Arguments

:: ByteString	key
-> Redis (Either Reply (Maybe ByteString))

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

srandmember Source

Arguments

:: ByteString	key
-> Redis (Either Reply (Maybe ByteString))

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

srem Source

Arguments

:: ByteString	key
-> [ByteString]	member
-> Redis (Either Reply Integer)

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

sunion Source

Arguments

:: [ByteString]	key
-> Redis (Either Reply [ByteString])

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

sunionstore Source

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 Source

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 Source

Arguments

:: ByteString	key
-> Redis (Either Reply Integer)

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

zcount Source

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 Source

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 Source

Constructors

Sum
Min
Max

Instances

Eq Aggregate
Show Aggregate

zinterstore Source

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 Source

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 Source

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 Source

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 Source

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 Source

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 Source

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 Source

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 Source

Arguments

:: ByteString	key
-> ByteString	member
-> Redis (Either Reply (Maybe Integer))

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

zrem Source

Arguments

:: ByteString	key
-> [ByteString]	member
-> Redis (Either Reply Integer)

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

zremrangebyrank Source

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 Source

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 Source

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 Source

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 Source

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 Source

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 Source

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 Source

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 Source

Arguments

:: ByteString	key
-> ByteString	member
-> Redis (Either Reply (Maybe Integer))

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

zscore Source

Arguments

:: ByteString	key
-> ByteString	member
-> Redis (Either Reply (Maybe Double))

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

zunionstore Source

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 Source

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 Source

Arguments

:: ByteString	key
-> ByteString	value
-> Redis (Either Reply Integer)

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

decr Source

Arguments

:: ByteString	key
-> Redis (Either Reply Integer)

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

decrby Source

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 Source

Arguments

:: ByteString	key
-> Redis (Either Reply (Maybe ByteString))

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

getbit Source

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 Source

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 Source

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 Source

Arguments

:: ByteString	key
-> Redis (Either Reply Integer)

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

incrby Source

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 Source

Arguments

:: [ByteString]	key
-> Redis (Either Reply [Maybe ByteString])

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

mset Source

Arguments

:: [(ByteString, ByteString)]	keyValue
-> Redis (Either Reply Status)

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

msetnx Source

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 Source

Arguments

:: ByteString	key
-> ByteString	value
-> Redis (Either Reply Status)

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

setbit Source

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 Source

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 Source

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 Source

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 Source

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

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

exec :: Redis (Either Reply Reply)Source

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

multi :: Redis (Either Reply Status)Source

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

unwatch :: Redis (Either Reply Status)Source

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

watch Source

Arguments

:: [ByteString]	key
-> Redis (Either Reply Status)

Watch the given keys to determine execution of the MULTI/EXEC block (http://redis.io/commands/watch).

Unimplemented Commands

These commands are not implemented, as of now. Library users can implement these or other commands from experimental Redis versions by using the sendRequest function.

EVAL (http://redis.io/commands/eval)
MONITOR (http://redis.io/commands/monitor)
SYNC (http://redis.io/commands/sync)

Pub/Sub

publish Source

Arguments

:: ByteString	channel
-> ByteString	message
-> Redis (Either Reply Integer)

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

pubSub Source

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 Source

Constructors

Message
Fields msgChannel :: ByteString msgMessage :: ByteString
PMessage
Fields msgPattern :: ByteString msgChannel :: ByteString msgMessage :: ByteString

Instances

Show Message

data PubSub Source

Instances

Monoid PubSub

subscribe Source

Arguments

:: [ByteString]	channel
-> PubSub

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

unsubscribe Source

Arguments

:: [ByteString]	channel
-> PubSub

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

psubscribe Source

Arguments

:: [ByteString]	pattern
-> PubSub

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

punsubscribe Source

Arguments

:: [ByteString]	pattern
-> PubSub

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

Low-Level Command API

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

sendRequest can be used to implement commands from experimental versions of Redis. An example of how to implement a command is given below.

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

data Reply Source

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 Source

Constructors

Ok
Pong
None
String
Hash
List
Set
ZSet
Queued

Instances

Eq Status
Show Status
RedisResult Status

class RedisResult a whereSource

Methods

decode :: Reply -> Either Reply aSource

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)

data ConnectionLostException Source

Constructors

ConnectionLost

Instances

Show ConnectionLostException
Typeable ConnectionLostException
Exception ConnectionLostException