StackRedis.Uri 1.0.1

StackRedis.Uri

A .NET 8 class library that parses redis:// and rediss:// URI strings into StackExchange.Redis ConfigurationOptions, with a ready-made Redis service and ASP.NET Core DI registration. Works with any Redis provider — Upstash, Redis Cloud, Fly.io, self-hosted, etc.

Installation

dotnet add package StackRedis.Uri

Configuration

Add the following to your appsettings.json:

"RedisConfig": {
  "ConnectionString": "redis://default:your-password@your-host:6379"
}

Use rediss:// and port 6380 for TLS connections (e.g. Upstash over TLS).

URI format: redis[s]://[username]:[password]@[host]:[port]

Registration

From configuration section

// Program.cs
builder.Services.AddRedisFromUri(builder.Configuration.GetSection("RedisConfig"));

From a URI string directly

builder.Services.AddRedisFromUri("rediss://default:password@host:6380");

Lazy connection (connects on first use)

builder.Services.AddRedisFromUriLazy(builder.Configuration.GetSection("RedisConfig"));
// or
builder.Services.AddRedisFromUriLazy("rediss://default:password@host:6380");

All overloads register the following as singletons:

• IConnectionMultiplexer
• IDatabase
• IRedisService

Usage

Inject IRedisService

public class MyService(IRedisService redis)
{
    public async Task CacheUserAsync(string userId, string data)
    {
        await redis.SetStringAsync($"user:{userId}", data, expirationMinutes: 60);
    }

    public async Task<string?> GetUserAsync(string userId)
    {
        return await redis.GetStringAsync($"user:{userId}");
    }

    public async Task InvalidateUserAsync(string userId)
    {
        await redis.DeleteAsync($"user:{userId}");
    }
}

Inject IConnectionMultiplexer (advanced)

public class MyService(IConnectionMultiplexer redis)
{
    public async Task PublishAsync(string channel, string message)
    {
        var pub = redis.GetSubscriber();
        await pub.PublishAsync(channel, message);
    }
}

API Reference

IRedisService

RedisUriParser

Parses a URI string directly into ConfigurationOptions without DI.

var options = RedisUriParser.Parse("rediss://default:password@host:6380");

// With custom overrides
var options = RedisUriParser.Parse("rediss://default:password@host:6380", opt =>
{
    opt.ConnectTimeout = 5000;
    opt.SyncTimeout = 1000;
});

RedisConnectionFactory

Creates a ConnectionMultiplexer directly without DI.

// Async
var connection = await RedisConnectionFactory.ConnectAsync("rediss://default:password@host:6380");

// Sync
var connection = RedisConnectionFactory.Connect("rediss://default:password@host:6380");

IDatabase db = connection.GetDatabase();

RedisConfig

Options class for binding Redis connection settings from appsettings.json. Use this when you want to bind configuration manually without the DI extensions.

Manual binding example:

var redisConfig = new RedisConfig();
builder.Configuration.GetSection("RedisConfig").Bind(redisConfig);

var options = RedisUriParser.Parse(redisConfig.ConnectionString);

IOptions<RedisConfig> pattern:

// Program.cs
builder.Services.Configure<RedisConfig>(builder.Configuration.GetSection("RedisConfig"));

// Your service
public class MyService(IOptions<RedisConfig> redisConfig)
{
    private readonly string _uri = redisConfig.Value.ConnectionString;
}

Default Connection Settings

All defaults can be overridden via the optional configure delegate on any registration method.

Requirements

• .NET 8
• A Redis instance accessible via a redis:// or rediss:// URI