Documentation

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.

Deconstruct Redis constructor.

unRedis and reRedis can be used to define instances for arbitrary typeclasses.

WARNING! These functions are considered internal and no guarantee is given at this point that they will not break in future.

Reconstruct Redis constructor.

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.

A collection of hook functions used by a connection.

A hook for sending commands to the server and receiving replies from the server.

This wraps the command-level request path used by most Redis commands.

A hook for sending pub/sub messages to the server.

A hook for invoking callbacks with pub/sub messages.

A hook for sending raw bytes to the server.

This sits below request rendering and can be used to observe the exact wire payload sent on the socket.

A hook for receiving replies from the server.

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]

Internal version of runRedis that does not depend on the Connection abstraction. Used to run the AUTH command when connecting.

The default hooks.

Every hook is the identity function, so installing defaultHooks has no effect on behavior.