Uniphar.Cosmos.Extensions 0.0.1

cosmos-extensions

NuGet package repository for Cosmos Extensions

Purpose

This library is intended for provisioning Az Cosmos Database(s) and container(s).

Setup your project to use Cosmos Extension package

When using this NuGet package you need to setup a few things in your project

appsettings.json

Add this to appsettings.json with the appropriate values needed in your solution.

  "StoreOptions": {
    "DatabaseName": "<name of database>",
    "DatabaseThroughput": <provisioned database throughput in RUs>,
    "Containers": [
      {
        "InstanceName": "<name of container>",
        "PartitionKey": "<name of partition key>",
        "ContainerThroughput": <provisioned database throughput in RUs>,
        "DefaultTimeToLiveInSeconds" : <TimeSpan(days, hours, seconds>
      },
      //...more containers to be defined
    ]
  }

NOTE: Worth noting on the settings.

• DatabaseThroughput: integer, if undefined (null) it will default to 400; it will provision database with auto scaling as Manual throughput has been dismissed.
• Containers:PartitionKey: string, if undefined (null), it will default to partioning by /partition
• Containers:ContainerThroughput: integer, if undefined (null) it will default to 400
• DefaultTimeToLiveInSeconds: TimeSpan defining for how long data sholuld be retained; if undefined (null) we implemenmt it to default to -1 (items don’t expire by default)

Program.cs

Add the following to Program.cs

• Add this to bind the above configuration section to class StoreOptions. That will ensure we can DI it into the where ever we need to make the call.

builder.Services.Configure<StoreOptions>(
    builder.Configuration.GetSection(nameof(StoreOptions)));

• Register a singleton instance of CosmosClient (MS recommendation) by adding this line

builder.Services.AddSingleton(CosmosClientExtension.CreateCosmosClient(builder.Configuration["Cosmos:ConnectionString"]));

NOTE: Cosmos Client connestionstring is defined in KeyVault.

CosmosInitialiser.cs (or other file responsible of Cosmos Initialisation)

Whatever file responsible for initialising cosmos database and containers (called from StartupBackgroundService.cs) has a method ExecuteAsync(CancellationToken stoppingToken). That method can be simplified to this

public async Task ExecuteAsync(CancellationToken stoppingToken)
{
    _logger.LogInformation("Creating Cosmos Database And Containers");
    
    await _cosmosExtension.ExecuteAsync(stoppingToken);
}

Create extended class of StoreOptions

Some APIs may have additional logic that is specific to the solutions. You can then create a class extension that inherits from StoreOptions. This is particular valid for PIMS API. You would create something like this.

    public class ExtendedStoreOptions : StoreOptions
    {
        /// <summary>
        /// Disable the account processing check
        /// </summary>
        /// <remarks>
        /// If set to true all account processing checks will return true
        /// Used to disable routing of requests to legacy pims system
        /// </remarks>
        public bool DisableAccountCheck { get; set; } = false;
    }

Your appsettings.json would look like this then

  "ExtendedStoreOptions": {
    "DatabaseName": "<name of database>",
    "DatabaseThroughput": <provisioned database throughput in RUs>,
    "DisableAccountCheck": true, // < --- this is the extra field from the above example
    "Containers": [
      {
        "InstanceName": "<name of container>",
        "PartitionKey": "<name of partition key>",
        "ContainerThroughput": <provisioned database throughput in RUs>,
        "DefaultTimeToLiveInSeconds" : <TimeSpan(days, hours, seconds>
      },
      //...more containers to be defined
    ]
  }

Your program.cs would then need to bind the config section like this

builder.Services.Configure<ExtendedStoreOptions>(
    builder.Configuration.GetSection(nameof(ExtendedStoreOptions)));

Likewise you;ll need to update Store.cs to reflect using ExtendedStoreOptions instead.