Shuttle.Recall.SqlServer.EventProcessing

A Sql Server implementation of the Shuttle.Recall event projection processing mechanism.

Installation

dotnet add package Shuttle.Recall.SqlServer.EventProcessing

Configuration

This package processes projections against events already stored via Shuttle.Recall.SqlServer.Storage — it reuses that package's connection, schema, and database-creation settings, so UseSqlServerEventStorage must be configured alongside UseSqlServerEventProcessing:

services
    .AddRecall()
    .UseSqlServerEventStorage(options =>
    {
        options.ConnectionString = "connection-string";
        options.Schema = "dbo";
    })
    .UseSqlServerEventProcessing(options =>
    {
        options.ProjectionPrefetchCount = 100;
    });

SqlServerEventProcessingOptions has the following properties:

Property	Default	Description
ProjectionPrefetchCount	100	Number of projection events fetched per round-trip
MaximumCacheSize	1000	Maximum number of entries kept in the event-type cache. Values above 100000 are clamped to 100000
CacheDuration	00:01:00	How long cached entries are retained. Values above 01:00:00 are clamped to 01:00:00
ProjectionLockTimeout	00:00:30	Timeout applied when acquiring a projection's processing lock

ConnectionString, Schema, and ConfigureDatabase are not properties of SqlServerEventProcessingOptions — they come from SqlServerStorageOptions (see Events: SQL Server) and are shared between both packages.

The default JSON settings structure (this package does not bind it automatically) is as follows:

{
  "Shuttle": {
    "Recall": {
      "SqlServer": {
        "EventProcessing": {
          "ProjectionPrefetchCount": 100,
          "MaximumCacheSize": 1000,
          "CacheDuration": "00:01:00",
          "ProjectionLockTimeout": "00:00:30"
        },
        "Storage": {
          "ConnectionString": "connection-string",
          "Schema": "dbo",
          "ConfigureDatabase": true
        }
      }
    }
  }
}

Database

In order to create the relevant database structures you can use the Shuttle.Recall.SqlServer.EventProcessing.Database console application and provide the connection-string and (optional) schema arguments. Alternatively, you can let the library create the structures by setting SqlServerStorageOptions.ConfigureDatabase to true (which is the default).

Immediate Consistency

When a projection is configured for immediate consistency (see Immediate Consistency), this package tracks each event that a projection has already handled immediately in an ImmediateProjectionEvent table, via IImmediateProjectionEventRepository. This allows the eventual event processor to skip re-invoking that projection's handler for an event it has already handled immediately, while still advancing the projection's checkpoint over it.

SequentialProjectionEventService

This package's IProjectionEventService implementation (see IProjectionEventService) is SequentialProjectionEventService, which retrieves, acknowledges, and defers projection events against the PrimitiveEvent, Projection, and ImmediateProjectionEvent tables.