Skip to main content

Redis Provider

The Redis provider offers key-value storage with TTL support, pub/sub integration, and dedicated inbox/outbox store implementations for the messaging infrastructure.

Before You Start​

  • .NET 8.0+ (or .NET 9/10 for latest features)
  • A Redis instance (local, Azure Cache for Redis, or ElastiCache)
  • Familiarity with data access and caching

Installation​

dotnet add package Excalibur.Data.Redis

Dependencies: Excalibur.Data.Abstractions, StackExchange.Redis

Quick Start​

using Microsoft.Extensions.DependencyInjection;

services.AddRedisInboxStore(options =>
{
    options.ConnectionString = "localhost:6379";
});

Registration Options​

Inbox Store​

// With options callback
services.AddRedisInboxStore(options =>
{
    options.ConnectionString = "localhost:6379";
    options.Database = 0;
});

// With connection string
services.AddRedisInboxStore("localhost:6379");

Outbox Store​

services.AddRedisOutboxStore(options =>
{
    options.ConnectionString = "localhost:6379";
    options.Database = 1;
});

// With connection string
services.AddRedisOutboxStore("localhost:6379");

Use Cases​

Redis is primarily used in Excalibur for:

  • Inbox deduplication — Ensure messages are processed exactly once
  • Outbox store — Reliable message publishing with at-least-once delivery
  • Caching layer — Paired with Excalibur.Dispatch.Caching for middleware-level caching
  • Leader election — See Excalibur.LeaderElection.Redis

See Also​