Microsoft.Orleans.Persistence.DynamoDB
9.2.0
Prefix Reserved
dotnet add package Microsoft.Orleans.Persistence.DynamoDB --version 9.2.0
NuGet\Install-Package Microsoft.Orleans.Persistence.DynamoDB -Version 9.2.0
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.DynamoDB" Version="9.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Microsoft.Orleans.Persistence.DynamoDB" Version="9.2.0" />
<PackageReference Include="Microsoft.Orleans.Persistence.DynamoDB" />
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.DynamoDB --version 9.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Microsoft.Orleans.Persistence.DynamoDB, 9.2.0"
#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.DynamoDB@9.2.0
#: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.DynamoDB&version=9.2.0
#tool nuget:?package=Microsoft.Orleans.Persistence.DynamoDB&version=9.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Microsoft Orleans Persistence for DynamoDB
Introduction
Microsoft Orleans Persistence for DynamoDB provides grain persistence for Microsoft Orleans using Amazon's DynamoDB. This allows your grains to persist their state in DynamoDB and reload it when they are reactivated.
Getting Started
To use this package, install it via NuGet:
dotnet add package Microsoft.Orleans.Persistence.DynamoDB
Example - Configuring DynamoDB Persistence
using Microsoft.Extensions.Hosting;
using Orleans.Configuration;
using Orleans.Hosting;
var builder = Host.CreateApplicationBuilder(args)
.UseOrleans(siloBuilder =>
{
siloBuilder
.UseLocalhostClustering()
// Configure DynamoDB as grain storage
.AddDynamoDBGrainStorage(
name: "dynamoStore",
configureOptions: options =>
{
options.AccessKey = "YOUR_AWS_ACCESS_KEY";
options.SecretKey = "YOUR_AWS_SECRET_KEY";
options.Region = "us-east-1";
options.TableName = "OrleansGrainState";
options.CreateIfNotExists = true;
});
});
// 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 the DynamoDB storage
public class MyGrain : Grain, IMyGrain, IGrainWithStringKey
{
private readonly IPersistentState<MyGrainState> _state;
public MyGrain([PersistentState("state", "dynamoStore")] 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
- 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 | Versions 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.
-
net8.0
- AWSSDK.DynamoDBv2 (>= 3.7.300.6)
- 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.0)
- Microsoft.Orleans.CodeGenerator (>= 9.2.0)
- Microsoft.Orleans.Runtime (>= 9.2.0)
- 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 (1)
Showing the top 1 NuGet packages that depend on Microsoft.Orleans.Persistence.DynamoDB:
Package | Downloads |
---|---|
Microsoft.Orleans.OrleansAWSUtils
Library of utility types for Amazon AWS of Microsoft Orleans. |
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on Microsoft.Orleans.Persistence.DynamoDB:
Repository | Stars |
---|---|
PiotrJustyna/road-to-orleans
This repository illustrates the road to orleans with practical, real-life examples. From most basic, to more advanced techniques.
|
Version | Downloads | Last Updated |
---|---|---|
9.2.0 | 0 | 7/14/2025 |
9.2.0-preview3 | 280 | 6/10/2025 |
9.2.0-preview2 | 141 | 6/4/2025 |
9.2.0-preview1 | 108 | 4/4/2025 |
9.1.2 | 34,330 | 2/13/2025 |
9.0.1 | 31,737 | 11/23/2024 |
9.0.0 | 1,076 | 11/14/2024 |
8.2.0 | 24,342 | 7/12/2024 |
8.2.0-preview1 | 178 | 5/22/2024 |
8.1.0 | 44,208 | 4/17/2024 |
8.1.0-preview3 | 235 | 3/11/2024 |
8.1.0-preview2 | 143 | 2/23/2024 |
8.1.0-preview1 | 139 | 2/13/2024 |
8.0.0 | 45,529 | 1/5/2024 |
8.0.0-rc2 | 256 | 12/20/2023 |
8.0.0-rc1 | 170 | 12/4/2023 |
7.2.7 | 148 | 10/15/2024 |
7.2.6 | 4,960 | 3/9/2024 |
7.2.5 | 184 | 2/22/2024 |
7.2.4 | 5,869 | 12/2/2023 |
7.2.3 | 13,737 | 11/3/2023 |
7.2.2 | 4,000 | 10/16/2023 |
7.2.1 | 12,471 | 7/11/2023 |
7.2.0 | 245 | 7/7/2023 |
7.1.2 | 22,700 | 4/19/2023 |
7.1.1 | 9,572 | 3/23/2023 |
7.1.0 | 4,093 | 2/1/2023 |
7.0.0 | 12,621 | 11/8/2022 |
7.0.0-rc2 | 300 | 10/19/2022 |
4.0.0-preview2 | 1,677 | 8/4/2022 |
4.0.0-preview1 | 2,041 | 2/10/2022 |
3.8.0 | 159 | 5/6/2025 |
3.8.0-preview5 | 213 | 5/12/2025 |
3.8.0-preview3 | 180 | 4/8/2025 |
3.8.0-preview2 | 111 | 4/4/2025 |
3.8.0-preview1 | 179 | 3/31/2025 |
3.7.2 | 3,190 | 5/10/2024 |
3.7.1 | 14,139 | 5/27/2023 |
3.7.0 | 1,742 | 3/23/2023 |
3.6.5 | 40,610 | 8/15/2022 |
3.6.4 | 499 | 8/10/2022 |
3.6.3 | 490 | 8/4/2022 |
3.6.2 | 16,182 | 4/15/2022 |
3.6.1 | 869 | 4/5/2022 |
3.6.0 | 7,994 | 1/20/2022 |
3.5.1 | 10,770 | 11/8/2021 |
3.5.0 | 17,410 | 9/3/2021 |
3.4.4 | 483 | 10/4/2021 |
3.4.3 | 6,480 | 6/3/2021 |
3.4.2 | 3,371 | 4/5/2021 |
3.4.1 | 11,531 | 2/3/2021 |
3.4.0 | 82,372 | 1/6/2021 |
3.4.0-rc1 | 484 | 12/9/2020 |
3.3.0 | 18,441 | 9/9/2020 |
3.3.0-rc2 | 454 | 9/2/2020 |
3.3.0-rc1 | 446 | 8/19/2020 |
3.2.2 | 6,096 | 7/22/2020 |
3.2.1 | 819 | 7/2/2020 |
3.2.0 | 1,339 | 6/4/2020 |
3.2.0-rc2 | 508 | 5/20/2020 |
3.2.0-rc1 | 455 | 5/7/2020 |
3.1.7 | 2,030 | 5/19/2020 |
3.1.6 | 6,025 | 4/16/2020 |
3.1.5 | 738 | 4/9/2020 |
3.1.4 | 1,259 | 3/26/2020 |
3.1.3 | 1,055 | 3/16/2020 |
3.1.2 | 3,056 | 3/5/2020 |
3.1.0 | 1,006 | 2/23/2020 |
3.1.0-rc3 | 539 | 2/13/2020 |
3.1.0-rc2 | 559 | 2/12/2020 |
3.1.0-rc1 | 589 | 2/10/2020 |
3.0.2 | 2,560 | 12/12/2019 |
3.0.1 | 802 | 11/27/2019 |
3.0.0 | 1,295 | 10/24/2019 |
3.0.0-rc2 | 602 | 10/16/2019 |
3.0.0-rc1 | 612 | 10/9/2019 |
3.0.0-beta1 | 1,247 | 8/16/2019 |
2.4.5 | 13,040 | 12/29/2019 |
2.4.4 | 1,159 | 11/27/2019 |
2.4.3 | 1,421 | 10/10/2019 |
2.4.2 | 5,755 | 8/31/2019 |
2.4.1 | 1,723 | 8/14/2019 |
2.4.0 | 1,505 | 8/8/2019 |
2.3.6 | 1,784 | 7/24/2019 |
2.3.5 | 5,223 | 6/14/2019 |
2.3.4 | 1,580 | 6/4/2019 |
2.3.3 | 1,290 | 6/2/2019 |
2.3.2 | 2,167 | 5/9/2019 |
2.3.1 | 1,415 | 4/26/2019 |
2.3.0 | 3,116 | 3/20/2019 |
2.3.0-rc2 | 684 | 3/13/2019 |
2.3.0-rc1 | 751 | 3/4/2019 |
2.2.4 | 2,311 | 2/25/2019 |
2.2.3 | 2,579 | 1/17/2019 |
2.2.0 | 1,481 | 12/13/2018 |
2.2.0-rc1 | 853 | 12/4/2018 |
2.2.0-beta1 | 973 | 10/21/2018 |
2.1.2 | 3,689 | 10/11/2018 |
2.1.0 | 1,670 | 9/28/2018 |
2.1.0-rc2 | 1,172 | 9/21/2018 |
2.1.0-rc1 | 1,192 | 9/14/2018 |
2.1.0-beta1 | 1,166 | 8/27/2018 |
2.0.0 | 8,617 | 3/28/2018 |
2.0.0-rc2 | 5,036 | 3/13/2018 |
2.0.0-rc1 | 1,179 | 2/26/2018 |
2.0.0-beta3 | 2,994 | 12/21/2017 |