# Redis v0.7.1 - Table of Contents

Modern, full-featured Redis client for Elixir with RESP3, clustering, sentinel, client-side caching, and resilience patterns

## Pages

- [Redis](readme.md)

## Modules

- [Redis](Redis.md): Modern, full-featured Redis client for Elixir.
- [Redis.Cache](Redis.Cache.md): Client-side caching using RESP3 server-assisted invalidation.
- [Redis.Cache.Allowlist](Redis.Cache.Allowlist.md): Default allowlist of cacheable read-only Redis commands and helpers
for normalizing user-provided cacheable configuration.
- [Redis.Cache.Backend](Redis.Cache.Backend.md): Behaviour for pluggable client-side cache backends.
- [Redis.Cache.Store](Redis.Cache.Store.md): ETS-backed cache store for client-side caching.
- [Redis.Cluster](Redis.Cluster.md): Redis Cluster client.
- [Redis.Cluster.Router](Redis.Cluster.Router.md): Hash slot router for Redis Cluster.
- [Redis.Cluster.Scan](Redis.Cluster.Scan.md): Cluster-wide SCAN — iterates keys across all master nodes transparently.
- [Redis.Cluster.Topology](Redis.Cluster.Topology.md): Parses cluster topology responses into slot-to-node mappings.
- [Redis.Codec](Redis.Codec.md): Behaviour for custom value encoding/decoding.
- [Redis.Codec.JSON](Redis.Codec.JSON.md): JSON codec using Jason.
- [Redis.Codec.Raw](Redis.Codec.Raw.md): Passthrough codec that performs no transformation.
- [Redis.Codec.Term](Redis.Codec.Term.md): Erlang external term format codec.
- [Redis.Commands.Bitmap](Redis.Commands.Bitmap.md): Command builders for Redis bitmap operations.
- [Redis.Commands.Bloom](Redis.Commands.Bloom.md): Command builders for Redis Bloom filter (`BF.*`) operations.
- [Redis.Commands.CMS](Redis.Commands.CMS.md): Command builders for Redis Count-Min Sketch (`CMS.*`) operations.
- [Redis.Commands.Cuckoo](Redis.Commands.Cuckoo.md): Command builders for Redis Cuckoo filter (`CF.*`) operations.
- [Redis.Commands.Function](Redis.Commands.Function.md): Command builders for Redis Functions (Redis 7+).
- [Redis.Commands.Geo](Redis.Commands.Geo.md): Command builders for Redis geospatial operations.
- [Redis.Commands.Hash](Redis.Commands.Hash.md): Command builders for Redis hash operations.
- [Redis.Commands.HyperLogLog](Redis.Commands.HyperLogLog.md): Command builders for Redis HyperLogLog probabilistic data structure.
- [Redis.Commands.JSON](Redis.Commands.JSON.md): Command builders for RedisJSON operations (Redis 8+ / RedisJSON module).
- [Redis.Commands.Key](Redis.Commands.Key.md): Command builders for Redis key management operations.
- [Redis.Commands.List](Redis.Commands.List.md): Command builders for Redis list operations.
- [Redis.Commands.PubSub](Redis.Commands.PubSub.md): Command builders for Redis Pub/Sub introspection and publishing.
- [Redis.Commands.Script](Redis.Commands.Script.md): Command builders for Redis Lua scripting and Redis Functions.
- [Redis.Commands.Search](Redis.Commands.Search.md): Command builders for RediSearch (FT.*) full-text search and indexing.
- [Redis.Commands.Server](Redis.Commands.Server.md): Command builders for Redis server administration and introspection.
- [Redis.Commands.Set](Redis.Commands.Set.md): Command builders for Redis set operations.
- [Redis.Commands.SortedSet](Redis.Commands.SortedSet.md): Command builders for Redis sorted set operations.
- [Redis.Commands.Stream](Redis.Commands.Stream.md): Command builders for Redis stream operations.
- [Redis.Commands.String](Redis.Commands.String.md): Command builders for Redis string operations.
- [Redis.Commands.TDigest](Redis.Commands.TDigest.md): Command builders for Redis t-digest (`TDIGEST.*`) operations.
- [Redis.Commands.TimeSeries](Redis.Commands.TimeSeries.md): Command builders for Redis TimeSeries (`TS.*`) operations.
- [Redis.Commands.TopK](Redis.Commands.TopK.md): Command builders for Redis Top-K (`TOPK.*`) operations.
- [Redis.Commands.VectorSet](Redis.Commands.VectorSet.md): Command builders for Redis Vector Set operations (Redis 8.0+).
- [Redis.Connection](Redis.Connection.md): GenServer managing a single TCP/TLS connection to a Redis server.
- [Redis.Connection.Behaviour](Redis.Connection.Behaviour.md): Behaviour defining the Redis connection interface.
- [Redis.Connection.Pool](Redis.Connection.Pool.md): Connection pool for Redis.
- [Redis.Consumer](Redis.Consumer.md): A GenServer for consuming Redis Streams via consumer groups.
- [Redis.Consumer.Handler](Redis.Consumer.Handler.md): Behaviour for handling messages from a Redis Streams consumer group.
- [Redis.CredentialProvider](Redis.CredentialProvider.md): Behaviour for dynamic credential providers.
- [Redis.CredentialProvider.Static](Redis.CredentialProvider.Static.md): A credential provider that returns static credentials.
- [Redis.Function](Redis.Function.md): High-level interface for Redis Functions (Redis 7+).
- [Redis.Hook](Redis.Hook.md): Behaviour for Redis command hooks (middleware).
- [Redis.JSON](Redis.JSON.md): High-level document API for RedisJSON.
- [Redis.OpenTelemetry](Redis.OpenTelemetry.md): Optional OpenTelemetry integration for Redis.
- [Redis.PhoenixPubSub](Redis.PhoenixPubSub.md): A Phoenix.PubSub adapter backed by Redis.
- [Redis.PlugSession](Redis.PlugSession.md): A Plug.Session.Store backed by Redis.
- [Redis.Protocol.Coerce](Redis.Protocol.Coerce.md): Coerces RESP2 flat-list responses into RESP3-style types based on the command.
- [Redis.Protocol.RESP2](Redis.Protocol.RESP2.md): RESP2 protocol encoder and decoder (fallback for older Redis servers).
- [Redis.Protocol.RESP3](Redis.Protocol.RESP3.md): RESP3 protocol encoder and decoder.
- [Redis.PubSub](Redis.PubSub.md): Pub/Sub client for Redis.
- [Redis.PubSub.Sharded](Redis.PubSub.Sharded.md): Sharded Pub/Sub client for Redis Cluster (Redis 7+).
- [Redis.Resilience](Redis.Resilience.md): Composable resilience wrapper for Redis connections.
- [Redis.Resilience.ErrorClassifier](Redis.Resilience.ErrorClassifier.md): Redis-specific error classifier for ExResilience.
- [Redis.Script](Redis.Script.md): Lua script helper with SHA1 caching.
- [Redis.Search](Redis.Search.md): High-level search API for Redis, inspired by Meilisearch.
- [Redis.Search.Result](Redis.Search.Result.md): Parsed search or aggregation result.
- [Redis.Sentinel](Redis.Sentinel.md): Sentinel-aware Redis connection.
- [Redis.Sentinel.Monitor](Redis.Sentinel.Monitor.md): Proactive sentinel failover monitor.
- [Redis.Telemetry](Redis.Telemetry.md): Telemetry events emitted by Redis.
- [Redis.URI](Redis.URI.md): Parses Redis URIs into connection options.
- [Redis.VectorSet](Redis.VectorSet.md): High-level API for Redis Vector Sets (Redis 8.0+).

- Exceptions
  - [Redis.ConnectionError](Redis.ConnectionError.md): Represents a connection-level error (socket closed, timeout, etc.).

  - [Redis.Error](Redis.Error.md): Represents a Redis error response.