Table of Contents

Class AutoSnapshotServiceCollectionExtensions

Namespace
Microsoft.Extensions.DependencyInjection
Assembly
Excalibur.EventSourcing.dll

Extension methods for configuring automatic snapshot policies on IEventSourcingBuilder.

public static class AutoSnapshotServiceCollectionExtensions
Inheritance
AutoSnapshotServiceCollectionExtensions
Inherited Members

Methods

UseAutoSnapshots(IEventSourcingBuilder, IConfiguration)

Configures automatic snapshot creation with global default options bound from an IConfiguration section.

[UnconditionalSuppressMessage("AOT", "IL2026:RequiresUnreferencedCode", Justification = "Options validation/binding uses reflection by design. AOT consumers should use source-generated alternatives.")]
[UnconditionalSuppressMessage("AOT", "IL3050:RequiresDynamicCode", Justification = "Configuration binding uses reflection by design. AOT consumers should use source-generated alternatives.")]
public static IEventSourcingBuilder UseAutoSnapshots(this IEventSourcingBuilder builder, IConfiguration configuration)

Parameters

builder IEventSourcingBuilder

The event sourcing builder.

configuration IConfiguration

The configuration section to bind AutoSnapshotOptions from.

Returns

IEventSourcingBuilder

The builder for fluent chaining.

Examples

services.AddExcalibur(x => x.AddEventSourcing(builder =>
{
    builder.UseAutoSnapshots(configuration.GetSection("AutoSnapshot"));
}));

Remarks

This overload binds options from configuration (e.g., appsettings.json) instead of an imperative Action<T> delegate. Data annotations are validated on start.

UseAutoSnapshots(IEventSourcingBuilder, Action<AutoSnapshotOptions>)

Configures automatic snapshot creation with global default options.

public static IEventSourcingBuilder UseAutoSnapshots(this IEventSourcingBuilder builder, Action<AutoSnapshotOptions> configure)

Parameters

builder IEventSourcingBuilder

The event sourcing builder.

configure Action<AutoSnapshotOptions>

Action to configure snapshot thresholds.

Returns

IEventSourcingBuilder

The builder for fluent chaining.

Examples

services.AddExcalibur(x => x.AddEventSourcing(builder =>
{
    builder.UseAutoSnapshots(options =>
    {
        options.EventCountThreshold = 100;
    });
}));

Remarks

Auto-snapshots are evaluated inline after SaveAsync succeeds. Snapshot creation is best-effort -- failure does not fail the save.

Use UseAutoSnapshots<TAggregate>(IEventSourcingBuilder, Action<AutoSnapshotOptions>) to override thresholds for specific aggregate types.

UseAutoSnapshots<TAggregate>(IEventSourcingBuilder, IConfiguration)

Configures automatic snapshot creation with per-aggregate-type overrides bound from an IConfiguration section.

[UnconditionalSuppressMessage("AOT", "IL2026:RequiresUnreferencedCode", Justification = "Options validation/binding uses reflection by design. AOT consumers should use source-generated alternatives.")]
[UnconditionalSuppressMessage("AOT", "IL3050:RequiresDynamicCode", Justification = "Configuration binding uses reflection by design. AOT consumers should use source-generated alternatives.")]
public static IEventSourcingBuilder UseAutoSnapshots<TAggregate>(this IEventSourcingBuilder builder, IConfiguration configuration) where TAggregate : class

Parameters

builder IEventSourcingBuilder

The event sourcing builder.

configuration IConfiguration

The configuration section to bind AutoSnapshotOptions from.

Returns

IEventSourcingBuilder

The builder for fluent chaining.

Type Parameters

TAggregate

The aggregate type to configure specific thresholds for.

Remarks

Per-aggregate-type options are registered as named options using the aggregate type name. They take precedence over the global defaults configured via UseAutoSnapshots(IEventSourcingBuilder, Action<AutoSnapshotOptions>).

UseAutoSnapshots<TAggregate>(IEventSourcingBuilder, Action<AutoSnapshotOptions>)

Configures automatic snapshot creation with per-aggregate-type overrides.

public static IEventSourcingBuilder UseAutoSnapshots<TAggregate>(this IEventSourcingBuilder builder, Action<AutoSnapshotOptions> configure) where TAggregate : class

Parameters

builder IEventSourcingBuilder

The event sourcing builder.

configure Action<AutoSnapshotOptions>

Action to configure snapshot thresholds for this aggregate type.

Returns

IEventSourcingBuilder

The builder for fluent chaining.

Type Parameters

TAggregate

The aggregate type to configure specific thresholds for.

Examples

services.AddExcalibur(x => x.AddEventSourcing(builder =>
{
    builder.UseAutoSnapshots(options =>
    {
        options.EventCountThreshold = 100;  // Global default
    });

    builder.UseAutoSnapshots<OrderAggregate>(options =>
    {
        options.EventCountThreshold = 50;   // Orders snapshot more frequently
        options.TimeThreshold = TimeSpan.FromHours(1);
    });
}));

Remarks

Per-aggregate-type options are registered as named options using the aggregate type name. They take precedence over the global defaults configured via UseAutoSnapshots(IEventSourcingBuilder, Action<AutoSnapshotOptions>).