Documentation

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

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"}

Or better yet, use parseConnectInfo to parse a URL.

Default information for connecting:

 connectAddr           = ConnectAddrHostPort "localhost" 6379 -- Redis default port
 connectAuth           = Nothing         -- No password
 connectUsername       = Nothing         -- No user
 connectDatabase       = 0               -- SELECT database 0
 connectMaxConnections = 50              -- Up to 50 connections
 connectNumStripes     = Just 1          -- A single stripe
 connectMaxIdleTime    = 30              -- Keep open for 30 seconds
 connectTimeout        = Nothing         -- Don't add timeout logic
 connectTLSParams      = Nothing         -- Do not use TLS
 connectHooks          = defaultHooks    -- Do nothing
 connectPoolLabel      = ""              -- no label

Constructs a Connection pool to a Redis server designated by the given ConnectInfo.

The function always succeeds, because the first connection is not actually established until the first call to the server.

Constructs a Connection pool to a Redis server designated by the given ConnectInfo, then tests if the server is actually there.

Throws an ConnectError exception if the connection to the Redis server can't be established.

Constructs a Connection pool to a Redis cluster designated by the given ConnectInfo, then tests if the server is actually there.

Throws an ClusterConnectError exception if the connection to the Redis server can't be established.

Destroy all idle resources in the pool, works for all types of the connection.

Memory bracket around connect and disconnect.

Memory bracket around checkedConnect and disconnect

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.

Interact with a Redis datastore specified by the given Connection, but return early if acquiring from the connection pool would block.

Like runRedis, but if all connections in the Connection pool are used, it immediately returns Nothing. This can be useful for logging purposes.

Constructs a ShardMap of connections to clustered nodes. The argument is a ConnectInfo for any node in the cluster

Some Redis commands are currently not supported in cluster mode - CONFIG, AUTH - SCAN - MOVE, SELECT - RESET