Microsoft.Orleans.Clustering.AdoNet 9.2.1

Prefix Reserved

dotnet add package Microsoft.Orleans.Clustering.AdoNet --version 9.2.1

NuGet\Install-Package Microsoft.Orleans.Clustering.AdoNet -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.Clustering.AdoNet" 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.Clustering.AdoNet" Version="9.2.1" />
                    

                            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.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Microsoft.Orleans.Clustering.AdoNet, 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.Clustering.AdoNet@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.Clustering.AdoNet&version=9.2.1
                    

                            Install as a Cake Addin

#tool nuget:?package=Microsoft.Orleans.Clustering.AdoNet&version=9.2.1
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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

If you have any issues or would like to provide feedback, please open an issue on GitHub
Join our community on Discord
Follow the @msftorleans Twitter account for Orleans announcements
Contributions are welcome! Please review our contribution guidelines
This project is licensed under the MIT license

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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- Microsoft.AspNetCore.Connections.Abstractions (>= 8.0.11)
- Microsoft.CodeAnalysis.Analyzers (>= 3.11.0)
- Microsoft.CodeAnalysis.Common (>= 4.5.0)
- Microsoft.CodeAnalysis.Workspaces.Common (>= 4.5.0)
- Microsoft.Extensions.Configuration (>= 8.0.0)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.Configuration.Json (>= 8.0.1)
- Microsoft.Extensions.DependencyInjection (>= 8.0.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Microsoft.Extensions.DependencyModel (>= 8.0.2)
- Microsoft.Extensions.Hosting (>= 8.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Logging (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.3)
- Microsoft.Extensions.Logging.Console (>= 8.0.1)
- Microsoft.Extensions.Logging.Debug (>= 8.0.1)
- Microsoft.Extensions.ObjectPool (>= 8.0.11)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 8.0.0)
- Microsoft.Orleans.Analyzers (>= 9.2.1)
- Microsoft.Orleans.CodeGenerator (>= 9.2.1)
- Microsoft.Orleans.Runtime (>= 9.2.1)
- Newtonsoft.Json (>= 13.0.3)
- System.Collections.Immutable (>= 8.0.0)
- System.IO.Hashing (>= 8.0.0)
- System.IO.Pipelines (>= 8.0.0)
- System.Memory.Data (>= 8.0.1)

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	828.5K
Aksio.Cratis.Extensions.Orleans Package Description	817.9K
KingMetal.Domains.Abstractions Package Description	357.9K
Mtl.Infrastructures.Workers 主要是封装了下Netty服务器和客户端的方法，提供了简单的方法调用就能启动Netty服务器和客户端，封装了Orleans的服务器和客户端的启动和连接方法，使操作简单，减少重复的代码	149.1K
ZLSoft.QWPlatform.WebBasics 基础服务	86.0K

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为主，一部分对以前案例进行升级，一部分将以前的工作经验总结出来，以供大家参考！	359
shinyorg/templates dotnet CLI & Visual Studio Templates	136

Version	Downloads	Last Updated
9.2.1	254	7/16/2025
9.2.0	398	7/14/2025
9.2.0-preview3	540	6/10/2025
9.2.0-preview2	207	6/4/2025
9.2.0-preview1	326	4/4/2025
9.1.2	50,299	2/13/2025
9.0.1	27,294	11/23/2024
9.0.0	2,916	11/14/2024
8.2.0	144,481	7/12/2024
8.2.0-preview1	345	5/22/2024
8.1.0	66,152	4/17/2024
8.1.0-preview3	237	3/11/2024
8.1.0-preview2	174	2/23/2024
8.1.0-preview1	139	2/13/2024
8.0.0	57,196	1/5/2024
8.0.0-rc2	949	12/20/2023
8.0.0-rc1	350	12/4/2023
7.2.7	3,743	10/15/2024
7.2.6	12,338	3/9/2024
7.2.5	223	2/22/2024
7.2.4	30,111	12/2/2023
7.2.3	6,459	11/3/2023
7.2.2	9,995	10/16/2023
7.2.1	187,451	7/11/2023
7.2.0	2,853	7/7/2023
7.1.2	83,778	4/19/2023
7.1.1	11,292	3/23/2023
7.1.0	18,828	2/1/2023
7.0.0	18,645	11/8/2022
7.0.0-rc2	613	10/19/2022
4.0.0-preview2	3,168	8/4/2022
4.0.0-preview1	3,032	2/10/2022
3.8.0	17,646	5/6/2025
3.8.0-preview5	227	5/12/2025
3.8.0-preview3	199	4/8/2025
3.8.0-preview2	134	4/4/2025
3.8.0-preview1	196	3/31/2025
3.7.2	128,537	5/10/2024
3.7.1	100,778	5/27/2023
3.7.0	22,855	3/23/2023
3.6.5	599,637	8/15/2022
3.6.4	13,472	8/10/2022
3.6.3	16,836	8/4/2022
3.6.2	151,813	4/15/2022
3.6.1	253,843	4/5/2022
3.6.0	290,636	1/20/2022
3.5.1	136,719	11/8/2021
3.5.0	190,104	9/3/2021
3.4.4	1,321	10/4/2021
3.4.3	70,252	6/3/2021
3.4.2	66,405	4/5/2021
3.4.1	137,525	2/3/2021
3.4.0	22,751	1/6/2021
3.4.0-rc1	479	12/9/2020
3.3.0	116,150	9/9/2020
3.3.0-rc2	695	9/2/2020
3.3.0-rc1	553	8/19/2020
3.2.2	100,848	7/22/2020
3.2.1	23,979	7/2/2020
3.2.0	25,394	6/4/2020
3.2.0-rc2	584	5/20/2020
3.2.0-rc1	594	5/7/2020
3.1.7	11,457	5/19/2020
3.1.6	50,170	4/16/2020
3.1.5	3,020	4/9/2020
3.1.4	9,430	3/26/2020
3.1.3	8,293	3/16/2020
3.1.2	15,037	3/5/2020
3.1.0	11,444	2/23/2020
3.1.0-rc3	658	2/13/2020
3.1.0-rc2	618	2/12/2020
3.1.0-rc1	669	2/10/2020
3.0.2	41,933	12/12/2019
3.0.1	17,722	11/27/2019
3.0.0	38,822	10/24/2019
3.0.0-rc2	816	10/16/2019
3.0.0-rc1	606	10/9/2019
3.0.0-beta1	43,888	8/16/2019
2.4.5	168,233	12/29/2019
2.4.4	47,928	11/27/2019
2.4.3	58,144	10/10/2019
2.4.2	37,297	8/31/2019
2.4.1	20,437	8/14/2019
2.4.0	3,231	8/8/2019
2.3.6	13,591	7/24/2019
2.3.5	40,229	6/14/2019
2.3.4	17,547	6/4/2019
2.3.3	3,219	6/2/2019
2.3.2	16,963	5/9/2019
2.3.1	12,735	4/26/2019
2.3.0	55,492	3/20/2019
2.3.0-rc2	3,473	3/13/2019
2.3.0-rc1	2,535	3/4/2019
2.2.4	5,844	2/25/2019
2.2.3	10,425	1/17/2019
2.2.0	28,361	12/13/2018
2.2.0-rc1	2,678	12/4/2018
2.2.0-beta1	3,283	10/21/2018
2.1.2	14,138	10/11/2018
2.1.0	8,098	9/28/2018
2.1.0-rc2	3,158	9/21/2018
2.1.0-rc1	3,249	9/14/2018
2.1.0-beta1	3,286	8/27/2018
2.0.0	24,308	3/28/2018
2.0.0-rc2	3,600	3/13/2018
2.0.0-rc1	3,426	2/26/2018
2.0.0-beta3	4,208	12/21/2017