Class BackupRestoreResult

Namespace

Typhon.Engine

Assembly

Typhon.Engine.dll

What a restore did.

public sealed record BackupRestoreResult : IEquatable<BackupRestoreResult>

Inheritance

object

BackupRestoreResult

Implements

IEquatable<BackupRestoreResult>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

BackupRestoreResult(BackupPointSummary, string, string, int, int, int, int, long, long, TimeSpan, IReadOnlyList<uint>, IReadOnlyList<PackPageDamage>, Guid, string)

What a restore did.

public BackupRestoreResult(BackupPointSummary Point, string Target, string DisplacedBundle, int ChainDepth, int PagesWritten, int ZeroPages, int TailSegments, long BytesRead, long BytesWritten, TimeSpan Duration, IReadOnlyList<uint> SuspectPages, IReadOnlyList<PackPageDamage> DamagedPages, Guid NewTimelineId, string SettleError)

Parameters

Point BackupPointSummary

The point restored.

Target string

The restored bundle.

DisplacedBundle string

Where the replaced bundle now is, or null.

ChainDepth int

The packs read.

PagesWritten int

The image's pages.

ZeroPages int

Pages written as zeros (never-written pages and all-zero ones).

TailSegments int

WAL segments recreated.

BytesRead long

Bytes read from the store.

BytesWritten long

Bytes written to the target.

Duration TimeSpan

Wall time, settle excluded.

SuspectPages IReadOnlyList<uint>

Pages the LIVE database had damaged at capture: a warning, not a defect of the backup.

DamagedPages IReadOnlyList<PackPageDamage>

Pages written despite failing their check (only with AllowDamaged).

NewTimelineId Guid

The WAL timeline the restored database starts at its first open.

SettleError string

What OpenAndClose threw, or null. The restore is published either way: the target and the displaced bundle are where this result says.

Properties

BytesRead

Bytes read from the store.

public long BytesRead { get; init; }

Property Value

long

BytesWritten

Bytes written to the target.

public long BytesWritten { get; init; }

Property Value

long

ChainDepth

The packs read.

public int ChainDepth { get; init; }

Property Value

int

DamagedPages

Pages written despite failing their check (only with AllowDamaged).

public IReadOnlyList<PackPageDamage> DamagedPages { get; init; }

Property Value

IReadOnlyList<PackPageDamage>

DisplacedBundle

Where the replaced bundle now is, or null.

public string DisplacedBundle { get; init; }

Property Value

string

Duration

Wall time, settle excluded.

public TimeSpan Duration { get; init; }

Property Value

TimeSpan

NewTimelineId

The WAL timeline the restored database starts at its first open.

public Guid NewTimelineId { get; init; }

Property Value

Guid

PagesWritten

The image's pages.

public int PagesWritten { get; init; }

Property Value

int

Point

The point restored.

public BackupPointSummary Point { get; init; }

Property Value

BackupPointSummary

SettleError

What OpenAndClose threw, or null. The restore is published either way: the target and the displaced bundle are where this result says.

public string SettleError { get; init; }

Property Value

string

SuspectPages

Pages the LIVE database had damaged at capture: a warning, not a defect of the backup.

public IReadOnlyList<uint> SuspectPages { get; init; }

Property Value

IReadOnlyList<uint>

TailSegments

WAL segments recreated.

public int TailSegments { get; init; }

Property Value

int

Target

The restored bundle.

public string Target { get; init; }

Property Value

string

ZeroPages

Pages written as zeros (never-written pages and all-zero ones).

public int ZeroPages { get; init; }

Property Value

int

Methods

Deconstruct(out BackupPointSummary, out string, out string, out int, out int, out int, out int, out long, out long, out TimeSpan, out IReadOnlyList<uint>, out IReadOnlyList<PackPageDamage>, out Guid, out string)

public void Deconstruct(out BackupPointSummary Point, out string Target, out string DisplacedBundle, out int ChainDepth, out int PagesWritten, out int ZeroPages, out int TailSegments, out long BytesRead, out long BytesWritten, out TimeSpan Duration, out IReadOnlyList<uint> SuspectPages, out IReadOnlyList<PackPageDamage> DamagedPages, out Guid NewTimelineId, out string SettleError)

Parameters

Point BackupPointSummary

Target string

DisplacedBundle string

ChainDepth int

PagesWritten int

ZeroPages int

TailSegments int

BytesRead long

BytesWritten long

Duration TimeSpan

SuspectPages IReadOnlyList<uint>

DamagedPages IReadOnlyList<PackPageDamage>

NewTimelineId Guid

SettleError string

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(BackupRestoreResult?)

public bool Equals(BackupRestoreResult? other)

Parameters

other BackupRestoreResult

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(BackupRestoreResult?, BackupRestoreResult?)

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

Parameters

left BackupRestoreResult

right BackupRestoreResult

Returns

bool

operator !=(BackupRestoreResult?, BackupRestoreResult?)

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

Parameters

left BackupRestoreResult

right BackupRestoreResult

Returns

bool