Class BackupArchiveStatus

Namespace

Typhon.Engine

Assembly

Typhon.Engine.dll

The WAL archive's state (#1418).

public sealed record BackupArchiveStatus : IEquatable<BackupArchiveStatus>

Inheritance

object

BackupArchiveStatus

Implements

IEquatable<BackupArchiveStatus>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

BackupArchiveStatus(BackupArchiveState, Guid, long, long, long, double, long, long, long, DateTime, int, string)

The WAL archive's state (#1418).

public BackupArchiveStatus(BackupArchiveState State, Guid TimelineId, long ArchivedThroughLsn, long LagBytes, long BacklogBytes, double LagSeconds, long GapsTotal, long LastGapFromLsn, long LastGapToLsn, DateTime LastArchivedSealUtc, int ConsecutiveFailures, string LastError)

Parameters

State BackupArchiveState

What it is doing.

TimelineId Guid

The timeline being archived.

ArchivedThroughLsn long

Every LSN up to this one is archived; 0 = nothing yet.

LagBytes long

Durable WAL bytes not archived yet.

BacklogBytes long

WAL bytes held on disk for the archive alone.

LagSeconds double

The RPO: 0 when everything durable is archived.

GapsTotal long

Gaps recorded this session.

LastGapFromLsn long

The last gap's first LSN; 0 = none.

LastGapToLsn long

The last gap's last LSN; 0 = none.

LastArchivedSealUtc DateTime

When the newest archived segment was sealed; MinValue when unknown.

ConsecutiveFailures int

Store failures in a row.

LastError string

The last failure, or null.

Properties

ArchivedThroughLsn

Every LSN up to this one is archived; 0 = nothing yet.

public long ArchivedThroughLsn { get; init; }

Property Value

long

BacklogBytes

WAL bytes held on disk for the archive alone.

public long BacklogBytes { get; init; }

Property Value

long

ConsecutiveFailures

Store failures in a row.

public int ConsecutiveFailures { get; init; }

Property Value

int

GapsTotal

Gaps recorded this session.

public long GapsTotal { get; init; }

Property Value

long

LagBytes

Durable WAL bytes not archived yet.

public long LagBytes { get; init; }

Property Value

long

LagSeconds

The RPO: 0 when everything durable is archived.

public double LagSeconds { get; init; }

Property Value

double

LastArchivedSealUtc

When the newest archived segment was sealed; MinValue when unknown.

public DateTime LastArchivedSealUtc { get; init; }

Property Value

DateTime

LastError

The last failure, or null.

public string LastError { get; init; }

Property Value

string

LastGapFromLsn

The last gap's first LSN; 0 = none.

public long LastGapFromLsn { get; init; }

Property Value

long

LastGapToLsn

The last gap's last LSN; 0 = none.

public long LastGapToLsn { get; init; }

Property Value

long

Off

Archiving off.

public static BackupArchiveStatus Off { get; }

Property Value

BackupArchiveStatus

State

What it is doing.

public BackupArchiveState State { get; init; }

Property Value

BackupArchiveState

TimelineId

The timeline being archived.

public Guid TimelineId { get; init; }

Property Value

Guid

Methods

Deconstruct(out BackupArchiveState, out Guid, out long, out long, out long, out double, out long, out long, out long, out DateTime, out int, out string)

public void Deconstruct(out BackupArchiveState State, out Guid TimelineId, out long ArchivedThroughLsn, out long LagBytes, out long BacklogBytes, out double LagSeconds, out long GapsTotal, out long LastGapFromLsn, out long LastGapToLsn, out DateTime LastArchivedSealUtc, out int ConsecutiveFailures, out string LastError)

Parameters

State BackupArchiveState

TimelineId Guid

ArchivedThroughLsn long

LagBytes long

BacklogBytes long

LagSeconds double

GapsTotal long

LastGapFromLsn long

LastGapToLsn long

LastArchivedSealUtc DateTime

ConsecutiveFailures int

LastError string

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(BackupArchiveStatus?)

public bool Equals(BackupArchiveStatus? other)

Parameters

other BackupArchiveStatus

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(BackupArchiveStatus?, BackupArchiveStatus?)

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

Parameters

left BackupArchiveStatus

right BackupArchiveStatus

Returns

bool

operator !=(BackupArchiveStatus?, BackupArchiveStatus?)

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

Parameters

left BackupArchiveStatus

right BackupArchiveStatus

Returns

bool