👁 Image
Microsoft.Orleans.Persistence.AdoNet 10.2.0

Microsoft Orleans Persistence for ADO.NET

Introduction

Microsoft Orleans Persistence for ADO.NET provides grain persistence for Microsoft Orleans using relational databases through ADO.NET. This provider allows your grains to persist their state in various relational databases including SQL Server, MySQL, PostgreSQL, and Oracle.

Getting Started

To use this package, install it via NuGet:

dotnet add package Microsoft.Orleans.Persistence.AdoNet

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

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

Example - Configuring ADO.NET Persistence

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

var builder = Host.CreateApplicationBuilder(args)
 .UseOrleans(siloBuilder =>
 {
 siloBuilder
 .UseLocalhostClustering()
 // Configure ADO.NET as grain storage
 .AddAdoNetGrainStorage(
 name: "AdoNetStore",
 configureOptions: options =>
 {
 options.Invariant = "Microsoft.Data.SqlClient"; // Or other providers like "MySql.Data.MySqlClient", "Npgsql", etc.
 options.ConnectionString = "Server=localhost;Database=OrleansStorage;User Id=myUsername;******;";
 // Optional: Configure custom queries
 });
 });

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

Example - Using Grain Storage in a Grain

using System;
using System.Threading.Tasks;
using Orleans;
using Orleans.Runtime;

// Define grain state class
public class MyGrainState
{
 public string Data { get; set; }
 public int Version { get; set; }
}

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

 public MyGrain([PersistentState("state", "AdoNetStore")] 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);
 }
}

Database Setup

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

• SQL Server Scripts
• MySQL Scripts
• PostgreSQL Scripts
• Oracle Scripts
• SQLite Scripts

Documentation

For more comprehensive documentation, please refer to:

• Microsoft Orleans Documentation
• Grain Persistence
• Relational Database Persistence

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