Table of Contents

Class ArchiveCandidate

Namespace
Excalibur.EventSourcing
Assembly
Excalibur.EventSourcing.Abstractions.dll

Describes an aggregate with events eligible for archival to cold storage.

public sealed record ArchiveCandidate : IEquatable<ArchiveCandidate>
Inheritance
ArchiveCandidate
Implements
Inherited Members

Remarks

The candidate carries the tenant that owns the events. Discovery enumerates across all tenants, so the tenant term cannot be supplied by the caller; it is read from the row and flows unchanged into both the cold write and the hot delete, so those two operations provably address the same tenant.

Constructors

ArchiveCandidate(KeyedTenantPartition, string, string, long, int)

Describes an aggregate with events eligible for archival to cold storage.

public ArchiveCandidate(KeyedTenantPartition Tenant, string AggregateId, string AggregateType, long ArchivableUpToVersion, int EventCount)

Parameters

Tenant KeyedTenantPartition

The tenant partition that owns the aggregate's events.

AggregateId string

The aggregate identifier.

AggregateType string

The aggregate type name.

ArchivableUpToVersion long

The inclusive ceiling of the safe archival prefix, before the first retained, ineligible, erased, or unresolved event. Previously archived markers may occur inside this prefix.

EventCount int

The number of payload-bearing events pending archival in the prefix.

Remarks

The candidate carries the tenant that owns the events. Discovery enumerates across all tenants, so the tenant term cannot be supplied by the caller; it is read from the row and flows unchanged into both the cold write and the hot delete, so those two operations provably address the same tenant.

Properties

AggregateId

The aggregate identifier.

public string AggregateId { get; init; }

Property Value

string

AggregateType

The aggregate type name.

public string AggregateType { get; init; }

Property Value

string

ArchivableUpToVersion

The inclusive ceiling of the safe archival prefix, before the first retained, ineligible, erased, or unresolved event. Previously archived markers may occur inside this prefix.

public long ArchivableUpToVersion { get; init; }

Property Value

long

EventCount

The number of payload-bearing events pending archival in the prefix.

public int EventCount { get; init; }

Property Value

int

Tenant

The tenant partition that owns the aggregate's events.

public KeyedTenantPartition Tenant { get; init; }

Property Value

KeyedTenantPartition