Orleans.Clustering.CosmosDB
1.3.0
See the version list below for details.
dotnet add package Orleans.Clustering.CosmosDB --version 1.3.0
NuGet\Install-Package Orleans.Clustering.CosmosDB -Version 1.3.0
<PackageReference Include="Orleans.Clustering.CosmosDB" Version="1.3.0" />
paket add Orleans.Clustering.CosmosDB --version 1.3.0
#r "nuget: Orleans.Clustering.CosmosDB, 1.3.0"
// Install Orleans.Clustering.CosmosDB as a Cake Addin #addin nuget:?package=Orleans.Clustering.CosmosDB&version=1.3.0 // Install Orleans.Clustering.CosmosDB as a Cake Tool #tool nuget:?package=Orleans.Clustering.CosmosDB&version=1.3.0
Configuration
It is not mandatory to use all the providers at once. Just pick the one you are interested in from the samples and you should be good as they don't depend on each other.
Silo
Example
var silo = new SiloHostBuilder()
.UseCosmosDBMembership(opt =>
{
// Use CosmosDB as the cluster membership table.
// Configure CosmosDB settings in opt.
})
.AddCosmosDBGrainStorageAsDefault(opt =>
{
// Configure CosmosDB persistence provider.
// Configure CosmosDB settings in opt.
})
.UseCosmosDBReminderService(op =>
{
// Configure CosmosDB reminders provider.
// Configure CosmosDB settings in opt.
})
.Build();
await silo.StartAsync();
Client
Example
var clientConfig = new ClientConfiguration();
var client = new ClientBuilder()
.UseCosmosDBGatewayListProvider(opt =>
{
// Use CosmosDB as the Gateway list provider.
// Configure CosmosDB settings in opt.
})
.Build();
await client.Connect();
Great! Now you have Orleans configured to use Azure CosmosDB as the back storage for its providers!
Custom partition keys for storage provider
By default the grain type is used as partition key, however this limits the storage size for a single grain type as a single logical partition has an upper limit of 10 GB storage.
It is possible to override the default by implementing a custom IPartitionKeyProvider
. The custom implementation of IPartitionKeyProvider
can be registered by using the dependency injection usual methods like:
services.AddSingleton<IPartitionKeyProvider, MyCustomPKProvider>();
There is also some overloads of AddCosmosDBGrainStorage
and AddCosmosDBGrainStorageAsDefault
that allow you to pass the IPartitionKeyProvider
implementation.
If no IPartitionKeyProvider
is used, the default one will be uses which use full name of the grain type will be used as partition key.
Example
public class PrimaryKeyPartitionKeyProvider : IPartitionKeyProvider
{
public ValueTask<string> GetPartitionKey(string grainType, GrainReference grainReference)
{
return new ValueTask<string>(grainReference.GetPrimaryKey().ToString());
}
}
The example above use the Primary key as partition key.
In order to prevent cross partition queries the partition key must be available to the client upon reading data, hence the delegate input is limited to the graintype and grainreference. The grain reference contains the grain id, with combination, and a type identifier.
For further details on partitioning in CosmosDB see https://docs.microsoft.com/en-us/azure/cosmos-db/partitioning-overview.
Backwards compatibility
The change will not affect existing systems. Configuring custom partition key builders for an existing system will throw a BadGrainStorageConfigException stating incompatibility. To start using custom partition key builders the old documents must be updated with a /PartitionKey property where the value is set using the same functionality as the Func<GrainReference, string> delegate specified in options. Once all documents are updated, the data must be migrated to a new CosmosDB collection using Azure Data Factory, CosmosDB Migration tool or custom code.
Indexing
The current indexing fork relies on CosmosDB stored procedures for lookup. As stored procedures must be executed against a specific partition, the use of custom partition key builders is not compatible with the Orleans indexing fork.
Contributions
PRs and feedback are very welcome!
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Microsoft.Azure.DocumentDB.Core (>= 2.2.3)
- Microsoft.Orleans.Core (>= 2.3.0)
- Microsoft.Orleans.OrleansRuntime (>= 2.3.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated | |
---|---|---|---|
3.0.4 | 39,830 | 6/16/2021 | |
3.0.3 | 2,225 | 4/24/2020 | |
3.0.2 | 555 | 3/23/2020 | |
3.0.1 | 768 | 1/29/2020 | |
3.0.0 | 735 | 11/14/2019 | |
1.3.0 | 942 | 4/3/2019 | |
1.2.1 | 732 | 3/20/2019 | |
1.2.0 | 720 | 3/19/2019 | |
1.1.42 | 1,324 | 9/28/2018 | |
1.1.41 | 822 | 9/28/2018 | |
1.1.40 | 1,146 | 3/28/2018 | |
1.1.38 | 1,018 | 3/28/2018 | |
1.1.0-rc2-36 | 868 | 3/13/2018 | |
1.1.0-rc1-34 | 861 | 3/12/2018 | |
1.1.0-rc1-29 | 856 | 2/27/2018 | |
1.0.1-preview-27 | 862 | 2/10/2018 | |
1.0.1-preview-25 | 878 | 2/5/2018 | |
1.0.1-preview-21 | 825 | 2/1/2018 | |
1.0.1-preview-19 | 863 | 2/1/2018 | |
1.0.0-preview-9 | 914 | 2/1/2018 | |
1.0.0-preview-8 | 886 | 2/1/2018 | |
1.0.0-preview-7 | 929 | 2/1/2018 | |
1.0.0-preview-17 | 838 | 2/1/2018 | |
1.0.0-preview-16 | 877 | 2/1/2018 | |
1.0.0-preview-14 | 888 | 2/1/2018 | |
1.0.0-preview-1 | 977 | 2/1/2018 |