StackExchange.Redis for C# (.NET): Complete Guide with Examples

\n\n

1. What It Is and Why You Need It

\n\n

StackExchange.Redis is a high-performance, asynchronous client for Redis, developed by the StackOverflow team. It is the de facto standard library for working with Redis in the .NET ecosystem. It is designed for .NET Framework 4.6+ and .NET Core/.NET 5+.

\n\n

Why do you need it? Redis is an in-memory data store often used as a cache, message broker (Pub/Sub), task queue, or high-performance NoSQL database. StackExchange.Redis provides a convenient API for all these scenarios: managing strings, hashes, lists, sets, transactions, Lua scripts, streaming data, etc. Without this library, you would have to write low-level code for working with sockets and the Redis protocol (RESP).

\n\n

The key feature of the library is its asynchrony and multithreading. It uses ConnectionMultiplexer — a single, shared object for all connections to the Redis server. This allows efficient use of sockets and avoids creating multiple connections. The library fully supports Redis Cluster, Sentinel, and replication.

\n\n

2. Installation

\n\n

Installation is done via NuGet Package Manager. Run one of the following commands in the Package Manager Console or in the .NET CLI terminal:

\n\n

// Via .NET CLI\ndotnet add package StackExchange.Redis\n\n// Via Package Manager Console\nInstall-Package StackExchange.Redis\n

\n\n

After installation, add the using directive to your code:

\n

using StackExchange.Redis;\n

\n\n

3. Quick Start — Minimal Working Example

\n\n

Below is a minimal example that connects to a local Redis server, writes a string, and reads it back:

\n\n

using StackExchange.Redis;\n\n// Create a multiplexer (entry point for all operations)\n// Replace "localhost:6379" with your Redis server address\nConnectionMultiplexer redis = ConnectionMultiplexer.Connect("localhost:6379");\n\n// Get the database (default db 0)\nIDatabase db = redis.GetDatabase();\n\n// Set a value\nbool setResult = db.StringSet("mykey", "Hello, Redis!");\nConsole.WriteLine($"Set result: {setResult}");\n\n// Get the value\nRedisValue value = db.StringGet("mykey");\nConsole.WriteLine($"Get result: {value}");\n\n// Close the connection (usually not required if using using)\nredis.Close();\n

\n\n

Important: ConnectionMultiplexer is a long-lived object. It should be created once for the entire lifetime of the application (e.g., as a singleton in a DI container). Do not create a new multiplexer for each request!

\n\n

4. Main Methods/Functions/Classes

\n\n

4.1. ConnectionMultiplexer.Connect()

\n

Signature: public static ConnectionMultiplexer Connect(string configuration)

\n

What it does: Creates and returns a new instance of ConnectionMultiplexer, which manages all connections to Redis. Accepts a configuration string (address, port, password, timeouts, etc.).

\n

Example:

\n

var redis = ConnectionMultiplexer.Connect("myredisserver.com:6379,password=secret,connectTimeout=5000");\n

\n\n

4.2. IDatabase.StringSet()

\n

Signature: bool StringSet(RedisKey key, RedisValue value, TimeSpan? expiry = null, When when = When.Always)

\n

What it does: Sets the value for the specified key. Can accept an optional expiry time and a condition (only if key exists, does not exist, etc.).

\n

Example:

\n

                
    

  
Also in library
  

                
                  
                 Calamine Rust Guide: Read Excel Files with Examples
      
                
                  
                 cpp-httplib Library: OAuth 2.0 Client in C++ for Web Applications
      
                
                  
                 Logging for TypeScript: Winston Library
      
                
                  
                 Testing in TypeScript: Frameworks and Tools
      
                
                  
                 Jetpack Compose for Kotlin: Complete Guide with Examples