Microsoft.Orleans.Clustering.AdoNet 9.2.0-preview3

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of Microsoft.Orleans.Clustering.AdoNet. 
dotnet add package Microsoft.Orleans.Clustering.AdoNet --version 9.2.0-preview3
                    


                    

                
NuGet\Install-Package Microsoft.Orleans.Clustering.AdoNet -Version 9.2.0-preview3
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.Clustering.AdoNet" Version="9.2.0-preview3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Microsoft.Orleans.Clustering.AdoNet" Version="9.2.0-preview3" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Microsoft.Orleans.Clustering.AdoNet" />
                    


                            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.Clustering.AdoNet --version 9.2.0-preview3
                    


                    

                
#r "nuget: Microsoft.Orleans.Clustering.AdoNet, 9.2.0-preview3"
#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. 
#addin nuget:?package=Microsoft.Orleans.Clustering.AdoNet&version=9.2.0-preview3&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Microsoft.Orleans.Clustering.AdoNet&version=9.2.0-preview3&prerelease
                    


                            Install as a Cake Tool

Microsoft Orleans Clustering Provider for ADO.NET

Introduction

Microsoft Orleans Clustering Provider for ADO.NET allows Orleans silos to organize themselves as a cluster using relational databases through ADO.NET. This provider enables silos to discover each other, maintain cluster membership, and detect and handle failures.

Getting Started

To use this package, install it via NuGet:

dotnet add package Microsoft.Orleans.Clustering.AdoNet

You will also need to install the appropriate database driver package for your database system:

  • SQL Server: Microsoft.Data.SqlClient or System.Data.SqlClient
  • MySQL: MySql.Data or MySqlConnector
  • PostgreSQL: Npgsql
  • Oracle: Oracle.ManagedDataAccess.Core
  • SQLite: Microsoft.Data.Sqlite

Example - Configuring ADO.NET Clustering

using Microsoft.Extensions.Hosting;
using Orleans.Configuration;
using Orleans.Hosting;
using Microsoft.Extensions.DependencyInjection;
using System;
using System.Threading.Tasks;

// Define a grain interface
public interface IHelloGrain : IGrainWithStringKey
{
    Task<string> SayHello(string greeting);
}

// Implement the grain interface
public class HelloGrain : Grain, IHelloGrain
{
    public Task<string> SayHello(string greeting)
    {
        return Task.FromResult($"Hello, {greeting}!");
    }
}

var builder = Host.CreateApplicationBuilder(args)
    .UseOrleans(siloBuilder =>
    {
        siloBuilder
            // Configure ADO.NET for clustering
            .UseAdoNetClustering(options =>
            {
                options.Invariant = "System.Data.SqlClient";  // Or other providers like "MySql.Data.MySqlClient", "Npgsql", etc.
                options.ConnectionString = "Server=localhost;Database=OrleansCluster;User Id=myUsername;******;";
            });
    });

var host = builder.Build();
await host.StartAsync();

// Get a reference to a grain and call it
var client = host.Services.GetRequiredService<IClusterClient>();
var grain = client.GetGrain<IHelloGrain>("user123");
var response = await grain.SayHello("World");

// Print the result
Console.WriteLine($"Grain response: {response}");

// Keep the host running until the application is shut down
await host.WaitForShutdownAsync();

Example - Configuring Client to Connect to Cluster

using Microsoft.Extensions.Hosting;
using Orleans;
using Orleans.Configuration;
using Microsoft.Extensions.DependencyInjection;
using System;
using System.Threading.Tasks;

// Define a grain interface
public interface IHelloGrain : IGrainWithStringKey
{
    Task<string> SayHello(string greeting);
}

var clientBuilder = Host.CreateApplicationBuilder(args)
    .UseOrleansClient(clientBuilder =>
    {
        clientBuilder
            // Configure the client to use ADO.NET for clustering
            .UseAdoNetClustering(options =>
            {
                options.Invariant = "System.Data.SqlClient";  // Or other providers like "MySql.Data.MySqlClient", "Npgsql", etc.
                options.ConnectionString = "Server=localhost;Database=OrleansCluster;User Id=myUsername;******;";
            });
    });

var host = clientBuilder.Build();
await host.StartAsync();
var client = host.Services.GetRequiredService<IClusterClient>();

// Get a reference to a grain and call it
var grain = client.GetGrain<IHelloGrain>("user123");
var response = await grain.SayHello("World");

// Print the result
Console.WriteLine($"Grain response: {response}");

// Keep the host running until the application is shut down
await host.WaitForShutdownAsync();

Database Setup

Before using the ADO.NET clustering provider, you need to set up the necessary database tables. Scripts for different database systems are available in the Orleans source repository: namespace ExampleGrains;

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 (20)

Showing the top 5 NuGet packages that depend on Microsoft.Orleans.Clustering.AdoNet:

Package Downloads
Microsoft.Orleans.OrleansSqlUtils

Library of utility types for relational storage of Microsoft Orleans
Aksio.Cratis.Extensions.Orleans

Package Description
KingMetal.Domains.Abstractions

Package Description
Mtl.Infrastructures.Workers

主要是封装了下Netty服务器和客户端的方法，提供了简单的方法调用就能启动Netty服务器和客户端，封装了Orleans的服务器和客户端的启动和连接方法，使操作简单，减少重复的代码
ZLSoft.QWPlatform.WebBasics

基础服务

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on Microsoft.Orleans.Clustering.AdoNet:

Repository Stars
axzxs2001/Asp.NetCoreExperiment
原来所有项目都移动到**OleVersion**目录下进行保留。新的案例装以.net 5.0为主，一部分对以前案例进行升级，一部分将以前的工作经验总结出来，以供大家参考！
shinyorg/templates
dotnet CLI & Visual Studio Templates
Version Downloads Last Updated
9.2.0-preview3 404 6/10/2025
9.2.0-preview2 200 6/4/2025
9.2.0-preview1 318 4/4/2025
9.1.2 42,178 2/13/2025
9.0.1 24,555 11/23/2024
9.0.0 2,901 11/14/2024
8.2.0 132,073 7/12/2024
8.2.0-preview1 340 5/22/2024
8.1.0 63,924 4/17/2024
8.1.0-preview3 228 3/11/2024
8.1.0-preview2 164 2/23/2024
8.1.0-preview1 135 2/13/2024
8.0.0 56,089 1/5/2024
8.0.0-rc2 942 12/20/2023
8.0.0-rc1 340 12/4/2023
7.2.7 3,143 10/15/2024
7.2.6 11,693 3/9/2024
7.2.5 219 2/22/2024
7.2.4 30,087 12/2/2023
7.2.3 6,455 11/3/2023
7.2.2 9,986 10/16/2023
7.2.1 178,694 7/11/2023
7.2.0 2,838 7/7/2023
7.1.2 83,101 4/19/2023
7.1.1 11,277 3/23/2023
7.1.0 18,796 2/1/2023
7.0.0 18,619 11/8/2022
7.0.0-rc2 597 10/19/2022
4.0.0-preview2 3,153 8/4/2022
4.0.0-preview1 3,019 2/10/2022
3.8.0 11,099 5/6/2025
3.8.0-preview5 218 5/12/2025
3.8.0-preview3 194 4/8/2025
3.8.0-preview2 122 4/4/2025
3.8.0-preview1 185 3/31/2025
3.7.2 123,498 5/10/2024
3.7.1 100,071 5/27/2023
3.7.0 22,783 3/23/2023
3.6.5 596,049 8/15/2022
3.6.4 13,455 8/10/2022
3.6.3 16,760 8/4/2022
3.6.2 151,306 4/15/2022
3.6.1 253,827 4/5/2022
3.6.0 283,230 1/20/2022
3.5.1 136,515 11/8/2021
3.5.0 189,503 9/3/2021
3.4.4 1,308 10/4/2021
3.4.3 69,630 6/3/2021
3.4.2 64,244 4/5/2021
3.4.1 136,205 2/3/2021
3.4.0 22,740 1/6/2021
3.4.0-rc1 468 12/9/2020
3.3.0 116,125 9/9/2020
3.3.0-rc2 677 9/2/2020
3.3.0-rc1 543 8/19/2020
3.2.2 100,826 7/22/2020
3.2.1 23,930 7/2/2020
3.2.0 25,380 6/4/2020
3.2.0-rc2 571 5/20/2020
3.2.0-rc1 575 5/7/2020
3.1.7 11,422 5/19/2020
3.1.6 50,151 4/16/2020
3.1.5 3,004 4/9/2020
3.1.4 9,417 3/26/2020
3.1.3 8,281 3/16/2020
3.1.2 15,025 3/5/2020
3.1.0 11,432 2/23/2020
3.1.0-rc3 646 2/13/2020
3.1.0-rc2 603 2/12/2020
3.1.0-rc1 657 2/10/2020
3.0.2 41,898 12/12/2019
3.0.1 17,710 11/27/2019
3.0.0 37,850 10/24/2019
3.0.0-rc2 801 10/16/2019
3.0.0-rc1 592 10/9/2019
3.0.0-beta1 43,479 8/16/2019
2.4.5 164,905 12/29/2019
2.4.4 47,429 11/27/2019
2.4.3 58,120 10/10/2019
2.4.2 37,280 8/31/2019
2.4.1 20,121 8/14/2019
2.4.0 3,218 8/8/2019
2.3.6 13,568 7/24/2019
2.3.5 40,188 6/14/2019
2.3.4 17,535 6/4/2019
2.3.3 3,207 6/2/2019
2.3.2 16,950 5/9/2019
2.3.1 12,721 4/26/2019
2.3.0 55,430 3/20/2019
2.3.0-rc2 3,458 3/13/2019
2.3.0-rc1 2,522 3/4/2019
2.2.4 5,807 2/25/2019
2.2.3 10,409 1/17/2019
2.2.0 28,341 12/13/2018
2.2.0-rc1 2,662 12/4/2018
2.2.0-beta1 3,270 10/21/2018
2.1.2 14,122 10/11/2018
2.1.0 8,071 9/28/2018
2.1.0-rc2 3,132 9/21/2018
2.1.0-rc1 3,224 9/14/2018
2.1.0-beta1 3,253 8/27/2018
2.0.0 24,247 3/28/2018
2.0.0-rc2 3,559 3/13/2018
2.0.0-rc1 3,382 2/26/2018
2.0.0-beta3 4,168 12/21/2017