Table of Contents

Class BackupArchiveTimeline

Namespace
Typhon.Engine
Assembly
Typhon.Engine.dll

One timeline of a store's WAL archive.

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

Constructors

BackupArchiveTimeline(Guid, Guid?, long, BackupTimelineReason, long, IReadOnlyList<BackupArchivedSegment>, IReadOnlyList<BackupArchiveGap>, IReadOnlyList<BackupTimeSample>, IReadOnlyList<KeyValuePair<string, string>>)

One timeline of a store's WAL archive.

public BackupArchiveTimeline(Guid TimelineId, Guid? ParentTimelineId, long OriginLsn, BackupTimelineReason Reason, long ArchivedThroughLsn, IReadOnlyList<BackupArchivedSegment> Segments, IReadOnlyList<BackupArchiveGap> Gaps, IReadOnlyList<BackupTimeSample> Samples, IReadOnlyList<KeyValuePair<string, string>> Unreadable)

Parameters

TimelineId Guid

Its id.

ParentTimelineId Guid?

The timeline it forked from; null for a genesis timeline or when not recorded.

OriginLsn long

The parent's last LSN this timeline continues; 0 for a genesis timeline.

Reason BackupTimelineReason

Why it exists.

ArchivedThroughLsn long

The archive's end; 0 when it holds no segment.

Segments IReadOnlyList<BackupArchivedSegment>

Its segments, ascending LSN.

Gaps IReadOnlyList<BackupArchiveGap>

The ranges missing from it.

Samples IReadOnlyList<BackupTimeSample>

Time samples, at most one per segment (its last).

Unreadable IReadOnlyList<KeyValuePair<string, string>>

Files of it that cannot be read, with why.

Properties

ArchivedThroughLsn

The archive's end; 0 when it holds no segment.

public long ArchivedThroughLsn { get; init; }

Property Value

long

Gaps

The ranges missing from it.

public IReadOnlyList<BackupArchiveGap> Gaps { get; init; }

Property Value

IReadOnlyList<BackupArchiveGap>

OriginLsn

The parent's last LSN this timeline continues; 0 for a genesis timeline.

public long OriginLsn { get; init; }

Property Value

long

ParentTimelineId

The timeline it forked from; null for a genesis timeline or when not recorded.

public Guid? ParentTimelineId { get; init; }

Property Value

Guid?

Reason

Why it exists.

public BackupTimelineReason Reason { get; init; }

Property Value

BackupTimelineReason

Samples

Time samples, at most one per segment (its last).

public IReadOnlyList<BackupTimeSample> Samples { get; init; }

Property Value

IReadOnlyList<BackupTimeSample>

Segments

Its segments, ascending LSN.

public IReadOnlyList<BackupArchivedSegment> Segments { get; init; }

Property Value

IReadOnlyList<BackupArchivedSegment>

TimelineId

Its id.

public Guid TimelineId { get; init; }

Property Value

Guid

Unreadable

Files of it that cannot be read, with why.

public IReadOnlyList<KeyValuePair<string, string>> Unreadable { get; init; }

Property Value

IReadOnlyList<KeyValuePair<string, string>>

Methods

Deconstruct(out Guid, out Guid?, out long, out BackupTimelineReason, out long, out IReadOnlyList<BackupArchivedSegment>, out IReadOnlyList<BackupArchiveGap>, out IReadOnlyList<BackupTimeSample>, out IReadOnlyList<KeyValuePair<string, string>>)

public void Deconstruct(out Guid TimelineId, out Guid? ParentTimelineId, out long OriginLsn, out BackupTimelineReason Reason, out long ArchivedThroughLsn, out IReadOnlyList<BackupArchivedSegment> Segments, out IReadOnlyList<BackupArchiveGap> Gaps, out IReadOnlyList<BackupTimeSample> Samples, out IReadOnlyList<KeyValuePair<string, string>> Unreadable)

Parameters

TimelineId Guid
ParentTimelineId Guid?
OriginLsn long
Reason BackupTimelineReason
ArchivedThroughLsn long
Segments IReadOnlyList<BackupArchivedSegment>
Gaps IReadOnlyList<BackupArchiveGap>
Samples IReadOnlyList<BackupTimeSample>
Unreadable IReadOnlyList<KeyValuePair<string, string>>

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(BackupArchiveTimeline?)

public bool Equals(BackupArchiveTimeline? other)

Parameters

other BackupArchiveTimeline

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(BackupArchiveTimeline?, BackupArchiveTimeline?)

public static bool operator ==(BackupArchiveTimeline? left, BackupArchiveTimeline? right)

Parameters

left BackupArchiveTimeline
right BackupArchiveTimeline

Returns

bool

operator !=(BackupArchiveTimeline?, BackupArchiveTimeline?)

public static bool operator !=(BackupArchiveTimeline? left, BackupArchiveTimeline? right)

Parameters

left BackupArchiveTimeline
right BackupArchiveTimeline

Returns

bool