Redis Scaffold

Redis Scaffold

Generate production-ready code patterns using StackExchange.Redis.Extensions.

When to use

When the user asks to implement:

• Redis Streams consumer group workflow
• GeoSpatial search (nearby locations)
• VectorSet similarity search (RAG, recommendations)
• Hash operations with per-field TTL
• Pub/Sub messaging
• HyperLogLog (unique counting, cardinality estimation)
• Distributed locking (mutual exclusion, critical sections)
• Bitmap operations (analytics, feature flags, DAU tracking)
• Lua scripting (atomic multi-command operations, rate limiting)
• Caching patterns (cache-aside, write-through, IDistributedCache)
• Atomic counters (increment/decrement)
• Set operations (union, intersect, difference)
• Key management (rename, type, dump/restore)
• Bulk operations

Patterns

Cache-Aside Pattern

public class ProductService(IRedisDatabase redis, IProductRepository repo)
{
    public async Task<Product?> GetProductAsync(int id)
    {
        var key = $"product:{id}";
        var cached = await redis.GetAsync<Product>(key);

        if (cached is not null)
            return cached;

        var product = await repo.GetByIdAsync(id);

        if (product is not null)
            await redis.AddAsync(key, product, TimeSpan.FromMinutes(30));

        return product;
    }
}

Consumer Group (Streams)

public class OrderProcessor(IRedisDatabase redis)
{
    public async Task ProcessAsync(CancellationToken ct)
    {
        await redis.StreamCreateConsumerGroupAsync("orders", "processors", "0-0", createStream: true);

        while (!ct.IsCancellationRequested)
        {
            var entries = await redis.StreamReadGroupAsync("orders", "processors", "worker-1", ">", count: 10); // ">" = read only new messages

            foreach (var entry in entries)
            {
                try
                {
                    // Process message
                    await redis.StreamAcknowledgeAsync("orders", "processors", entry.Id.ToString());
                }
                catch
                {
                    // Message stays in PEL for retry
                }
            }

            if (entries.Length == 0)
                await Task.Delay(1000, ct);
        }
    }
}

GeoSpatial Search

public class StoreLocator(IRedisDatabase redis)
{
    public async Task<GeoRadiusResult[]> FindNearbyAsync(double lat, double lon, double radiusKm)
    {
        return await redis.GeoSearchAsync("stores", lon, lat,
            new GeoSearchCircle(radiusKm, GeoUnit.Kilometers),
            count: 20, order: Order.Ascending);
    }

    public async Task AddStoreAsync(string id, double lat, double lon)
    {
        await redis.GeoAddAsync("stores", lon, lat, id);
    }
}

VectorSet Similarity Search (RAG)

public class DocumentSearch(IRedisDatabase redis)
{
    public async Task IndexAsync(string docId, float[] embedding, string title)
    {
        await redis.VectorSetAddAsync("docs",
            VectorSetAddRequest.Member(docId, embedding,
                attributes: $"""{{ "title": "{title}" }}"""));
    }

    public async Task<List<(string Id, double Score)>> SearchAsync(float[] queryVector, int topK = 5)
    {
        using var results = await redis.VectorSetSimilaritySearchAsync("docs",
            VectorSetSimilaritySearchRequest.ByVector(queryVector) with { Count = topK });

        var items = new List<(string, double)>();
        if (results is not null)
            foreach (var r in results.Span)
                items.Add((r.Member!, r.Score));

        return items;
    }
}

Hash with Per-Field TTL

public class SessionStore(IRedisDatabase redis)
{
    public async Task SetSessionDataAsync(string userId, string token, object profile)
    {
        var hashKey = $"user:{userId}";

        // Permanent profile data
        await redis.HashSetAsync(hashKey, "profile", profile);

        // Session token expires in 30 minutes
        await redis.HashSetWithExpiryAsync(hashKey, "token", token, TimeSpan.FromMinutes(30));
    }
}

Pub/Sub with Typed Messages

public class EventBus(IRedisDatabase redis)
{
    public async Task PublishAsync<T>(string channel, T message)
    {
        await redis.PublishAsync(new RedisChannel(channel, RedisChannel.PatternMode.Literal), message);
    }

    public async Task SubscribeAsync<T>(string channel, Func<T?, Task> handler)
    {
        await redis.SubscribeAsync<T>(new RedisChannel(channel, RedisChannel.PatternMode.Literal), handler);
    }
}

Bulk Operations with Expiry

public async Task CacheBulkAsync(IRedisDatabase redis, Dictionary<string, Product> products)
{
    var items = products.Select(p => Tuple.Create($"product:{p.Key}", p.Value)).ToArray();
    await redis.AddAllAsync(items, TimeSpan.FromHours(1));
}

Atomic Counters

public class RateLimiter(IRedisDatabase redis)
{
    public async Task<bool> AllowRequestAsync(string clientId, int maxRequests, TimeSpan window)
    {
        var key = $"ratelimit:{clientId}";
        var count = await redis.StringIncrementAsync(key);

        if (count == 1)
            await redis.UpdateExpiryAsync(key, window);

        return count <= maxRequests;
    }
}

Set Combine (Union, Intersect, Difference)

public class TagService(IRedisDatabase redis)
{
    public async Task<string[]> GetCommonTagsAsync(string user1, string user2)
    {
        return await redis.SetCombineAsync<string>(
            SetOperation.Intersect, $"user:{user1}:tags", $"user:{user2}:tags");
    }

    public async Task<long> MergeTagsAsync(string destination, params string[] sources)
    {
        return await redis.SetCombineAndStoreAsync(
            SetOperation.Union, destination, sources);
    }
}

HyperLogLog (Unique Counting)

public class UniqueVisitorCounter(IRedisDatabase redis)
{
    public async Task TrackVisitorAsync(string page, string userId)
    {
        await redis.HyperLogLogAddAsync($"visitors:{page}", userId);
    }

    public async Task<long> GetUniqueVisitorsAsync(string page)
    {
        return await redis.HyperLogLogLengthAsync($"visitors:{page}");
    }

    public async Task<long> GetTotalUniqueAcrossPagesAsync(string[] pages)
    {
        var keys = pages.Select(p => $"visitors:{p}").ToArray();
        return await redis.HyperLogLogLengthAsync(keys);
    }

    public async Task MergeDailyIntoMonthlyAsync(string month, string[] dailyKeys)
    {
        await redis.HyperLogLogMergeAsync($"visitors:monthly:{month}", dailyKeys);
    }
}

Distributed Lock

public class OrderProcessor(IRedisDatabase redis)
{
    public async Task ProcessOrderAsync(int orderId)
    {
        await using var lockObj = await redis.LockAcquireAsync(
            $"lock:order:{orderId}",
            expiry: TimeSpan.FromSeconds(30),
            maxRetries: 5,
            retryDelay: TimeSpan.FromMilliseconds(200));

        if (lockObj is null)
            throw new InvalidOperationException($"Could not acquire lock for order {orderId}");

        // Critical section — only one worker processes this order
        await DoProcessing(orderId);

        // Lock auto-released on dispose
    }

    public async Task LongRunningTaskAsync(string resourceId)
    {
        await using var lockObj = await redis.LockAcquireAsync(
            $"lock:{resourceId}", TimeSpan.FromSeconds(10));

        if (lockObj is null)
            return;

        // Extend if work takes longer than expected
        var extended = await lockObj.ExtendAsync(TimeSpan.FromSeconds(30));
        if (!extended)
            return; // Lock was lost

        await DoLongWork(resourceId);
    }
}

Bitmap (Analytics / Feature Flags)

public class UserAnalytics(IRedisDatabase redis)
{
    public async Task TrackDailyActiveAsync(long userId)
    {
        var today = DateTime.UtcNow.ToString("yyyy-MM-dd");
        await redis.StringSetBitAsync($"dau:{today}", userId, true);
    }

    public async Task<long> GetDailyActiveCountAsync(string date)
    {
        return await redis.StringBitCountAsync($"dau:{date}");
    }

    public async Task<long> GetWeeklyRetentionAsync(string[] dailyKeys)
    {
        // Users active on ALL days
        await redis.StringBitOperationAsync(Bitwise.And, "retention:week", dailyKeys);
        return await redis.StringBitCountAsync("retention:week");
    }
}

public class FeatureFlags(IRedisDatabase redis)
{
    public async Task EnableForUserAsync(string feature, long userId)
    {
        await redis.StringSetBitAsync($"feature:{feature}", userId, true);
    }

    public async Task<bool> IsEnabledAsync(string feature, long userId)
    {
        return await redis.StringGetBitAsync($"feature:{feature}", userId);
    }
}

Lua Scripting (Atomic Operations)

public class AtomicRateLimiter(IRedisDatabase redis)
{
    private const string RateLimitScript = """
        local key = KEYS[1]
        local limit = tonumber(ARGV[1])
        local window = tonumber(ARGV[2])
        local current = tonumber(redis.call('GET', key) or '0')
        if current < limit then
            redis.call('INCR', key)
            if current == 0 then
                redis.call('EXPIRE', key, window)
            end
            return 1
        end
        return 0
        """;

    public async Task<bool> AllowRequestAsync(string clientId, int limit, int windowSeconds)
    {
        var result = await redis.ScriptEvaluateAsync(
            RateLimitScript,
            new RedisKey[] { $"ratelimit:{clientId}" },
            new RedisValue[] { limit, windowSeconds });

        return (long)result == 1;
    }
}

public class AtomicCounter(IRedisDatabase redis)
{
    private const string IncrWithCeilingScript = """
        local current = tonumber(redis.call('GET', KEYS[1]) or '0')
        if current < tonumber(ARGV[1]) then
            return redis.call('INCR', KEYS[1])
        end
        return current
        """;

    public async Task<long> IncrementWithCeilingAsync(string key, long ceiling)
    {
        var result = await redis.ScriptEvaluateAsync(
            IncrWithCeilingScript,
            new RedisKey[] { key },
            new RedisValue[] { ceiling });

        return (long)result;
    }
}

Key Management

// Rename with condition
await redis.KeyRenameAsync("temp:data", "final:data", When.NotExists);

// Check type before operations
var type = await redis.KeyTypeAsync("my-key"); // RedisType.String, Set, Hash, ...

// Dump and restore (migrate between databases)
var dump = await redis.KeyDumpAsync("source-key");
await redis.KeyRestoreAsync("dest-key", dump, TimeSpan.FromHours(24));

IDistributedCache

// Registered via: builder.Services.AddRedisDistributedCache()
public class SessionService(IDistributedCache cache)
{
    public async Task SetAsync(string sessionId, byte[] data)
    {
        await cache.SetAsync($"session:{sessionId}", data, new DistributedCacheEntryOptions
        {
            SlidingExpiration = TimeSpan.FromMinutes(20),
            AbsoluteExpirationRelativeToNow = TimeSpan.FromHours(4),
        });
    }
}

Important Notes

• All values go through ISerializer — strings are JSON-encoded ("hello" → ""hello"")
• For raw Redis operations, use redis.Database directly
• KeyPrefix applies to both keys AND Pub/Sub channels
• VectorSet requires Redis 8.0+
• Hash field expiry requires Redis 7.4+
• Compression wraps ISerializer transparently — all operations benefit automatically
• Lease return types (VectorSet search) must be disposed after use
• Bitmap operations do NOT use serialization — they work directly with bit offsets
• Distributed locks use a GUID holder value — only the holder can release/extend
• LockAcquireAsync returns null (not exception) when lock cannot be acquired
• Lua scripts should use KEYS[n] and ARGV[n] — never hardcode key names (cluster compatibility)
• ScriptEvaluateReadOnlyAsync uses EVALRO and can be routed to replicas