Table of Contents

Class SnapshotUpgradingBuilder

Namespace
Excalibur.EventSourcing.DependencyInjection
Assembly
Excalibur.EventSourcing.dll

Builder for configuring snapshot upgrading infrastructure.

public sealed class SnapshotUpgradingBuilder
Inheritance
SnapshotUpgradingBuilder
Inherited Members

Remarks

This builder registers ISnapshotUpgrader implementations with the SnapshotVersionManager for automatic snapshot version migration during aggregate hydration.

Usage:

services.AddExcalibur(x => x.AddEventSourcing(builder => builder
    .AddSnapshotUpgrading(upgrading => upgrading
        .RegisterUpgrader<OrderSnapshotV1, OrderSnapshotV2>(new OrderSnapshotUpgraderV1ToV2(serializer))
        .SetCurrentVersion("OrderAggregate", 3))));

Methods

EnableAutoUpgradeOnLoad(bool)

Enables or disables automatic snapshot upgrading during aggregate hydration.

public SnapshotUpgradingBuilder EnableAutoUpgradeOnLoad(bool enable = true)

Parameters

enable bool

True to enable; false to disable.

Returns

SnapshotUpgradingBuilder

The builder for fluent configuration.

RegisterUpgrader(ISnapshotUpgrader)

Registers a snapshot upgrader instance.

public SnapshotUpgradingBuilder RegisterUpgrader(ISnapshotUpgrader upgrader)

Parameters

upgrader ISnapshotUpgrader

The upgrader to register.

Returns

SnapshotUpgradingBuilder

The builder for fluent configuration.

SetCurrentVersion(int)

Sets the current snapshot version for all aggregates.

public SnapshotUpgradingBuilder SetCurrentVersion(int version)

Parameters

version int

The target snapshot version.

Returns

SnapshotUpgradingBuilder

The builder for fluent configuration.