API Reference Redis v#0.8.0

Copy Markdown View Source

Modules

Modern, full-featured Redis client for Elixir.

Client-side caching using RESP3 server-assisted invalidation.

Default allowlist of cacheable read-only Redis commands and helpers for normalizing user-provided cacheable configuration.

Behaviour for pluggable client-side cache backends.

ETS-backed cache store for client-side caching.

Redis Cluster client.

Hash slot router for Redis Cluster.

Cluster-wide SCAN — iterates keys across all master nodes transparently.

Parses cluster topology responses into slot-to-node mappings.

Behaviour for custom value encoding/decoding.

JSON codec using Jason.

Passthrough codec that performs no transformation.

Erlang external term format codec.

Command builders for Redis bitmap operations.

Command builders for Redis Bloom filter (BF.*) operations.

Command builders for Redis Count-Min Sketch (CMS.*) operations.

Command builders for Redis Cuckoo filter (CF.*) operations.

Command builders for Redis Functions (Redis 7+).

Command builders for Redis geospatial operations.

Command builders for Redis hash operations.

Command builders for Redis HyperLogLog probabilistic data structure.

Command builders for RedisJSON operations (Redis 8+ / RedisJSON module).

Command builders for Redis key management operations.

Command builders for Redis list operations.

Command builders for Redis Pub/Sub introspection and publishing.

Command builders for Redis Lua scripting and Redis Functions.

Command builders for RediSearch (FT.*) full-text search and indexing.

Command builders for Redis server administration and introspection.

Command builders for Redis set operations.

Command builders for Redis sorted set operations.

Command builders for Redis stream operations.

Command builders for Redis string operations.

Command builders for Redis t-digest (TDIGEST.*) operations.

Command builders for Redis TimeSeries (TS.*) operations.

Command builders for Redis Top-K (TOPK.*) operations.

Command builders for Redis Vector Set operations (Redis 8.0+).

GenServer managing a single TCP/TLS connection to a Redis server.

Behaviour defining the Redis connection interface.

Connection pool for Redis.

Represents a connection-level error (socket closed, timeout, etc.).

A GenServer for consuming Redis Streams via consumer groups.

Behaviour for handling messages from a Redis Streams consumer group.

Behaviour for dynamic credential providers.

A credential provider that returns static credentials.

Represents a Redis error response.

High-level interface for Redis Functions (Redis 7+).

Behaviour for Redis command hooks (middleware).

High-level document API for RedisJSON.

Streams commands observed by Redis' MONITOR command.

A structured command received from Redis MONITOR.

Optional OpenTelemetry integration for Redis.

A Phoenix.PubSub adapter backed by Redis.

A Plug.Session.Store backed by Redis.

Coerces RESP2 flat-list responses into RESP3-style types based on the command.

RESP2 protocol encoder and decoder (fallback for older Redis servers).

RESP3 protocol encoder and decoder.

Pub/Sub client for Redis.

Sharded Pub/Sub client for Redis Cluster (Redis 7+).

Routes writes to a Redis primary and eligible reads to replicas.

Composable resilience wrapper for Redis connections.

Redis-specific error classifier for ExResilience.

Opt-in conversion of raw Redis replies into stable Elixir values.

A parsed record returned by CLIENT LIST or CLIENT INFO.

A named stream and the entries returned by XREAD or XREADGROUP.

A Redis stream entry with its ID and field/value map.

Represents a failure while converting a raw Redis reply to a typed response.

Lua script helper with SHA1 caching.

High-level search API for Redis, inspired by Meilisearch.

Parsed search or aggregation result.

Sentinel-aware Redis connection.

Proactive sentinel failover monitor.

Telemetry events emitted by Redis.

Parses Redis URIs into connection options.

High-level API for Redis Vector Sets (Redis 8.0+).