Class Snapshot

Namespace

Stratara.Abstractions.EventSourcing

Assembly

Stratara.Abstractions.dll

Aggregate snapshot — periodic state capture that lets the aggregation service skip replaying every event from the start of a stream.

[ExcludeFromCodeCoverage]
public sealed class Snapshot : IEntity, IMultiTenant, IBucket, IHasRowVersion

Inheritance

object

Snapshot

Implements

IEntity

IMultiTenant

IBucket

IHasRowVersion

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

FieldChangedEventExtensions.ApplyPropertyChanged<TAggregate>(TAggregate, FieldChangedEvent<TAggregate>)

EventStream.ApplyEvents(object, IReadOnlyList<IEvent>)

Remarks

TenantId is the Subject (data owner) of the aggregate — same value as TenantId for the underlying stream.

Properties

AggregateTypeName

Assembly-qualified type name of the owning aggregate, as produced when the snapshot is written. It carries the assembly version, so reads must match it version-independently (see GetAsync(Guid, string, long?, CancellationToken)).

public required string AggregateTypeName { get; set; }

Property Value

string

BucketId

The bucket index in [0, BucketCount).

public required int BucketId { get; set; }

Property Value

int

DataJson

Serialised aggregate state as JSON.

public required string DataJson { get; set; }

Property Value

string

Id

The entity's primary-key identifier.

public Guid Id { get; set; }

Property Value

Guid

RowVersion

Current row version as read from xmin. Set by EF Core on save.

public uint RowVersion { get; set; }

Property Value

uint

StreamId

Id of the stream the snapshot captures.

public Guid StreamId { get; set; }

Property Value

Guid

TenantId

The Subject (data-owner) tenant id.

public required Guid TenantId { get; set; }

Property Value

Guid

Timestamp

When the snapshot was written.

public DateTimeOffset Timestamp { get; set; }

Property Value

DateTimeOffset

Version

Stream version the snapshot reflects (inclusive).

public long Version { get; set; }

Property Value

long