Papst.EventStore.AzureCosmos 5.2.7

There is a newer version of this package available.
See the version list below for details.

dotnet add package Papst.EventStore.AzureCosmos --version 5.2.7

NuGet\Install-Package Papst.EventStore.AzureCosmos -Version 5.2.7

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="Papst.EventStore.AzureCosmos" Version="5.2.7" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Papst.EventStore.AzureCosmos" Version="5.2.7" />
                    

                            Directory.Packages.props

<PackageReference Include="Papst.EventStore.AzureCosmos" />
                    

                            Project file

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 Papst.EventStore.AzureCosmos --version 5.2.7

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Papst.EventStore.AzureCosmos, 5.2.7"

#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 Papst.EventStore.AzureCosmos@5.2.7

#: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=Papst.EventStore.AzureCosmos&version=5.2.7
                    

                            Install as a Cake Addin

#tool nuget:?package=Papst.EventStore.AzureCosmos&version=5.2.7
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Azure Cosmos Implementation of Event Stream

The Azure Cosmos Implementation needs to be added to the dependency injection container.

To achieve this, there are two extension methods available, one using a client factory function and one a direct CosmosClient parameter:

IServiceCollection services;

// direct CosmosClient parameter
services.AddCosmosEventStore(
    new CosmosClient(...),
    "database",
    "container");

// CosmosClient Factory, that has a IServiceProvider as parameter
services.AddCosmosEventStore(
    sp => sp.GetRequiredService<CosmosClient>(),
    "database",
    "container");

In addition it is necessary to Configure the class CosmosEventStoreOptions with the options below.

Configuration

The CosmosEventStore class uses the Options pattern to retrieve its configuration. Therefore a ConfigurationSection can be added to the AddCosmosEventStore extension method for the IServiceCollection. The C# representation of the Configuration Sections looks like this:

public class CosmosEventStoreOptions
{
  /// <summary>
  /// Count of retries when two parties are updating the same stream to avoid concurrency issues
  /// </summary>
  public int ConcurrencyRetryCount { get; set; } = 3;
  
  /// <summary>
  /// Whether to try to build the index for an existing stream, when no index is found
  /// or to return a <see cref="Papst.EventStore.Exceptions.EventStreamNotFoundException"/>
  /// </summary>
  public bool BuildIndexOnNotFound { get; set; }
  
  /// <summary>
  /// Flag if the Tenant Id of the Stream Meta Data should be updated when appending a new event
  /// </summary>
  public bool UpdateTenantIdOnAppend { get; set; } = true;
}

Migration

With the new V5 based implementation, there is need for an index document in the cosmos database for each stream.

For a convenient upgrade, there has been an option to the configuration added, that builds an index, when a stream is requested using GetAsync method in IEventStore and the stream is not found.

A manual upgrade is not yet supported.

Product	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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- Azure.Core (>= 1.43.0)
- Microsoft.Azure.Cosmos (>= 3.43.1)
- Microsoft.Extensions.Options (>= 8.0.2)
- Nerdbank.GitVersioning (>= 3.6.143)
- Newtonsoft.Json (>= 13.0.3)
- Papst.EventStore (>= 5.2.7)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.