Microsoft.Orleans.Persistence.Redis 9.2.1

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Microsoft.Orleans.Persistence.Redis --version 9.2.1
                    


                    

                
NuGet\Install-Package Microsoft.Orleans.Persistence.Redis -Version 9.2.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Microsoft.Orleans.Persistence.Redis" Version="9.2.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Microsoft.Orleans.Persistence.Redis" Version="9.2.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Microsoft.Orleans.Persistence.Redis" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Microsoft.Orleans.Persistence.Redis --version 9.2.1
                    


                    

                
#r "nuget: Microsoft.Orleans.Persistence.Redis, 9.2.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Microsoft.Orleans.Persistence.Redis@9.2.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Microsoft.Orleans.Persistence.Redis&version=9.2.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Microsoft.Orleans.Persistence.Redis&version=9.2.1
                    


                            Install as a Cake Tool

Microsoft Orleans Persistence for Redis

Introduction

Microsoft Orleans Persistence for Redis provides grain persistence for Microsoft Orleans using Redis. This allows your grains to persist their state in Redis and reload it when they are reactivated, leveraging Redis's in-memory data store for fast access.

Getting Started

To use this package, install it via NuGet:

dotnet add package Microsoft.Orleans.Persistence.Redis

Example - Configuring Redis Persistence

using Microsoft.Extensions.Hosting;
using Orleans.Configuration;
using Orleans.Hosting;

var builder = Host.CreateApplicationBuilder(args)
    .UseOrleans(siloBuilder =>
    {
        siloBuilder
            .UseLocalhostClustering()
            // Configure Redis as grain storage
            .AddRedisGrainStorage(
                name: "redisStore",
                configureOptions: options =>
                {
                    options.ConnectionString = "localhost:6379";
                    options.Database = 0;
                    options.UseJson = true; // Serializes grain state as JSON
                    options.KeyPrefix = "grain-"; // Optional prefix for Redis keys
                });
    });

// Run the host
await builder.RunAsync();

Example - Using Grain Storage in a Grain

// Define grain state class

public class MyGrainState
{
    public string Data { get; set; }
    public int Version { get; set; }
}

// Grain implementation that uses Redis storage
public class MyGrain : Grain, IMyGrain, IGrainWithStringKey
{
    private readonly IPersistentState<MyGrainState> _state;

    public MyGrain([PersistentState("state", "redisStore")] IPersistentState<MyGrainState> state)
    {
        _state = state;
    }

    public async Task SetData(string data)
    {
        _state.State.Data = data;
        _state.State.Version++;
        await _state.WriteStateAsync();
    }

    public Task<string> GetData()
    {
        return Task.FromResult(_state.State.Data);
    }
}

Documentation

For more comprehensive documentation, please refer to:

Feedback & Contributing

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on Microsoft.Orleans.Persistence.Redis:

Package Downloads
Cszy.Orleans

Package Description
SiloX.Orleans.Persistence.Redis

Redis persistence module that for Microsoft Orleans.
Fancyx.Orleans

Orleans配置,Redis集群,Redis存储

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on Microsoft.Orleans.Persistence.Redis:

Repository Stars
dodyg/practical-aspnetcore
Practical samples of ASP.NET Core 10 RC 1, 9, 8.0, 7.0, 6.0, 5.0, 3.1, 2.2, and 2.1,projects you can use. Readme contains explanations on all projects.
dotnet/aspire-samples
Version Downloads Last Updated
9.2.1 37,180 7/16/2025
9.2.0 1,681 7/14/2025
9.2.0-preview3 743 6/10/2025
9.2.0-preview2 197 6/4/2025
9.2.0-preview1 7,089 4/4/2025
9.1.2 54,230 2/13/2025
9.0.1 33,440 11/23/2024
9.0.0 3,288 11/14/2024
8.2.0 73,829 7/12/2024
8.2.0-preview1 596 5/22/2024
8.1.0 35,571 4/17/2024
8.1.0-preview3 802 3/11/2024
8.1.0-preview2 133 2/23/2024
8.1.0-preview1 360 2/13/2024
8.0.0 20,429 1/5/2024
8.0.0-rc2 431 12/20/2023
8.0.0-rc1 290 12/4/2023
7.2.7 1,539 10/15/2024
7.2.6 1,477 3/9/2024
7.2.5 1,895 2/22/2024
7.2.4 7,559 12/2/2023
7.2.3 3,785 11/3/2023
7.2.2 21,644 10/16/2023
7.2.1 15,528 7/11/2023
7.2.0 941 7/7/2023
7.1.2-beta1 694 4/19/2023
7.1.1-beta1 414 3/23/2023
7.1.0-beta1 524 2/1/2023