Orleans.Clustering.CosmosDB 3.0.4

配置

不需要一次性使用所有提供程序。只需从示例中选择您感兴趣的一个即可，因为它们之间不互相依赖。

节点

示例

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

客户端

示例

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

太好了！现在您已经配置了 Orleans，使其使用 Azure CosmosDB 作为其提供程序的后端存储！

存储提供程序的自定义分区键

默认情况下，使用 grain 类型作为分区键，但这限制了单个 grain 类型的存储大小，因为单个逻辑分区有最大 10 GB 的存储上限。

可以通过实现自定义 IPartitionKeyProvider 来覆盖默认设置。可以通过 dependency injection 的常规方法注册 IPartitionKeyProvider 的自定义实现。

services.AddSingleton<IPartitionKeyProvider, MyCustomPKProvider>();

还有几种 AddCosmosDBGrainStorage 和 AddCosmosDBGrainStorageAsDefault 的重载，允许您传递 IPartitionKeyProvider 的实现。

如果没有使用 IPartitionKeyProvider，将使用默认值，它使用 grain 类型的完整名称作为分区键。

示例

public class PrimaryKeyPartitionKeyProvider : IPartitionKeyProvider
{
    public ValueTask<string> GetPartitionKey(string grainType, GrainReference grainReference) 
    {
        return new ValueTask<string>(grainReference.GetPrimaryKey().ToString());
    }
}

上面的示例使用主键作为分区键。

为了防止跨分区查询，分区键必须在读取数据时对客户端可用，因此代表输入仅限于 grain type 和 grain reference。Grain reference 包含 grain id，组合以及一个类型标识符。

有关 CosmosDB 分区详情的更多信息，请参阅 https://docs.microsoft.com/en-us/azure/cosmos-db/partitioning-overview。

向下兼容性

此更改不会影响现有系统。为现有系统配置自定义分区键生成器将引发 BadGrainStorageConfigException，表明不兼容。要开始使用自定义分区键生成器，必须使用与选项中指定的 Func 代表相同的函数将旧文档更新为 /PartitionKey 属性。一旦所有文档都更新完毕，就必须使用 Azure Data Factory、CosmosDB 迁移工具或自定义代码将数据迁移到新的 CosmosDB 集合。

索引

当前的索引分支依赖于 CosmosDB 存储过程进行查找。因为存储过程必须针对特定分区执行，所以自定义分区键生成器与 Orleans 索引分支不兼容。

贡献

PR 和反馈都 非常 欢迎！