Class BackupPointSummary

Namespace

Typhon.Engine

Assembly

Typhon.Engine.dll

One backup point, as its pack's header and footer describe it.

public sealed record BackupPointSummary : IEquatable<BackupPointSummary>

Inheritance

object

BackupPointSummary

Implements

IEquatable<BackupPointSummary>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

BackupPointSummary(uint, BackupPointKind, Guid, uint, uint, long, long, int, int, int, bool, bool, DateTime, DateTime, Guid, int, string, long)

One backup point, as its pack's header and footer describe it.

public BackupPointSummary(uint BackupId, BackupPointKind Kind, Guid ChainId, uint ParentId, uint BaseId, long CheckpointLsn, long PointLsn, int ImagePages, int PageCount, int TailSegments, bool Suspect, bool Offline, DateTime FreezeUtc, DateTime TailEndUtc, Guid TimelineId, int FormatRevision, string PackFile, long PackBytes)

Parameters

BackupId uint

The point's id in its store; never reused.

Kind BackupPointKind

Full, incremental or compacted.

ChainId Guid

The chain it belongs to.

ParentId uint

The point it extends; 0 for a base.

BaseId uint

The base of its chain.

CheckpointLsn long

C: where the restored database's replay starts.

PointLsn long

P: the last LSN the restored database holds.

ImagePages int

The data file's length in pages at the freeze.

PageCount int

The pages the pack itself holds.

TailSegments int

The WAL segments it carries.

Suspect bool

The live database had damaged pages at capture; the point keeps them faithfully.

Offline bool

Captured from a closed database.

FreezeUtc DateTime

The freeze instant.

TailEndUtc DateTime

When its tail copy ended.

TimelineId Guid

The WAL timeline of the database it was taken from.

FormatRevision int

The image's on-disk format revision.

PackFile string

The pack's file name in packs/.

PackBytes long

The pack's size.

Properties

BackupId

The point's id in its store; never reused.

public uint BackupId { get; init; }

Property Value

uint

BaseId

The base of its chain.

public uint BaseId { get; init; }

Property Value

uint

ChainId

The chain it belongs to.

public Guid ChainId { get; init; }

Property Value

Guid

CheckpointLsn

C: where the restored database's replay starts.

public long CheckpointLsn { get; init; }

Property Value

long

FormatRevision

The image's on-disk format revision.

public int FormatRevision { get; init; }

Property Value

int

FreezeUtc

The freeze instant.

public DateTime FreezeUtc { get; init; }

Property Value

DateTime

ImagePages

The data file's length in pages at the freeze.

public int ImagePages { get; init; }

Property Value

int

Kind

Full, incremental or compacted.

public BackupPointKind Kind { get; init; }

Property Value

BackupPointKind

Offline

Captured from a closed database.

public bool Offline { get; init; }

Property Value

bool

PackBytes

The pack's size.

public long PackBytes { get; init; }

Property Value

long

PackFile

The pack's file name in packs/.

public string PackFile { get; init; }

Property Value

string

PageCount

The pages the pack itself holds.

public int PageCount { get; init; }

Property Value

int

ParentId

The point it extends; 0 for a base.

public uint ParentId { get; init; }

Property Value

uint

PointLsn

P: the last LSN the restored database holds.

public long PointLsn { get; init; }

Property Value

long

Suspect

The live database had damaged pages at capture; the point keeps them faithfully.

public bool Suspect { get; init; }

Property Value

bool

TailEndUtc

When its tail copy ended.

public DateTime TailEndUtc { get; init; }

Property Value

DateTime

TailSegments

The WAL segments it carries.

public int TailSegments { get; init; }

Property Value

int

TimelineId

The WAL timeline of the database it was taken from.

public Guid TimelineId { get; init; }

Property Value

Guid

Methods

Deconstruct(out uint, out BackupPointKind, out Guid, out uint, out uint, out long, out long, out int, out int, out int, out bool, out bool, out DateTime, out DateTime, out Guid, out int, out string, out long)

public void Deconstruct(out uint BackupId, out BackupPointKind Kind, out Guid ChainId, out uint ParentId, out uint BaseId, out long CheckpointLsn, out long PointLsn, out int ImagePages, out int PageCount, out int TailSegments, out bool Suspect, out bool Offline, out DateTime FreezeUtc, out DateTime TailEndUtc, out Guid TimelineId, out int FormatRevision, out string PackFile, out long PackBytes)

Parameters

BackupId uint

Kind BackupPointKind

ChainId Guid

ParentId uint

BaseId uint

CheckpointLsn long

PointLsn long

ImagePages int

PageCount int

TailSegments int

Suspect bool

Offline bool

FreezeUtc DateTime

TailEndUtc DateTime

TimelineId Guid

FormatRevision int

PackFile string

PackBytes long

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(BackupPointSummary?)

public bool Equals(BackupPointSummary? other)

Parameters

other BackupPointSummary

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(BackupPointSummary?, BackupPointSummary?)

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

Parameters

left BackupPointSummary

right BackupPointSummary

Returns

bool

operator !=(BackupPointSummary?, BackupPointSummary?)

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

Parameters

left BackupPointSummary

right BackupPointSummary

Returns

bool