Redis is an open source, advanced key-value store. It is often referred to as a data structure server since keys can contain strings, hashes, lists, sets and sorted sets. This library is a Haskell client for the Redis datastore.

Compared to other Haskell client libraries it has some advantages:

• Compatibility with Latest Stable Redis: Hedis is intended to be used with any version of Redis starting with 5.0 to 8.8. But pay attention to the Since annotation that tells when the command was introduced in Redis. The library does not provide static checks and unsupported commands will result in a runtime error. Most Redis commands (http://redis.io/commands) are available as Haskell functions, although MONITOR and SYNC are intentionally omitted. Additionally, a low-level API is exposed that makes it easy for the library user to implement further commands, such as new commands from an experimental Redis version.

• Automatic Optimal Pipelining: Commands are pipelined (http://redis.io/topics/pipelining) as much as possible without any work by the user. See http://informatikr.com/2012/redis-pipelining.html for a technical explanation of automatic optimal pipelining.

• Enforced Pub/Sub semantics: When subscribed to the Redis Pub/Sub server (http://redis.io/topics/pubsub), clients are not allowed to issue commands other than subscribing to or unsubscribing from channels. This library uses the type system to enforce the correct behavior.

• Connect via TCP or Unix Domain Socket: TCP sockets are the default way to connect to a Redis server. For connections to a server on the same machine, Unix domain sockets offer higher performance than the standard TCP connection.

• Cluster and multi-instance support: Hedis supports Redis Cluster and Redis Sentinel.

For detailed documentation, see the Database.Redis module.

• Database
  • Database.Redis
    • Database.Redis.Cluster
      • Database.Redis.Cluster.Command
      • Database.Redis.Cluster.HashSlot
    • Database.Redis.Commands
    • Database.Redis.Connection
    • Database.Redis.ConnectionContext
    • Database.Redis.Core
      • Database.Redis.Core.Internal
    • Database.Redis.Hooks
    • Database.Redis.ManualCommands
      • Database.Redis.ManualCommands.BF
      • Database.Redis.ManualCommands.CF
      • Database.Redis.ManualCommands.Cms
      • Database.Redis.ManualCommands.FT
      • Database.Redis.ManualCommands.Function
      • Database.Redis.ManualCommands.JSON
      • Database.Redis.ManualCommands.Tdigest
      • Database.Redis.ManualCommands.Topk
      • Database.Redis.ManualCommands.Ts
      • Database.Redis.ManualCommands.Wait
    • Database.Redis.Protocol
    • Database.Redis.ProtocolPipelining
    • Database.Redis.PubSub
    • Database.Redis.Sentinel
    • Database.Redis.Transactions
    • Database.Redis.Types
    • Database.Redis.URL