Class NcLuggageArchiveResult

Namespace

Hi.SqliteUtils

Assembly

HiNc.dll

Internal Use Only. What Archive(string, string, int, int, DateTime, IProgress<IMessage>, NcLuggageArchiveOptions) answers: Archived with the counts of the file written, or Skipped with the bytes the gate compared (a failure is thrown, not answered).

public sealed record NcLuggageArchiveResult : IEquatable<NcLuggageArchiveResult>

Inheritance

object

NcLuggageArchiveResult

Implements

IEquatable<NcLuggageArchiveResult>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])

InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)

InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)

ColorUtil.GetGloomyColor(object, double, double)

KindNameUtil.KindName(object)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Constructors

NcLuggageArchiveResult(NcLuggageArchiveOutcome, long, long, long, long, long, long, int, TimeSpan, long?, long, long, long)

Internal Use Only. What Archive(string, string, int, int, DateTime, IProgress<IMessage>, NcLuggageArchiveOptions) answers: Archived with the counts of the file written, or Skipped with the bytes the gate compared (a failure is thrown, not answered).

public NcLuggageArchiveResult(NcLuggageArchiveOutcome Outcome, long Rows, long ForceRows, long HeaderOnlyForceRows, long EngagementRows, long SourceBytes, long FileBytes, int PageSize, TimeSpan Elapsed, long? FreeBytes, long BoundBytes, long NeededBytes, long ReservedBytes = 0)

Parameters

Outcome NcLuggageArchiveOutcome

Archived or Skipped.

Rows long

The rows copied: every step cache row of the step range, the rows whose two columns are NULL included.

ForceRows long

The rows whose force column is not NULL.

HeaderOnlyForceRows long

The force rows stored as the no-cut record's 8-byte header (an untouched step under active physics).

EngagementRows long

The rows whose engagement column is not NULL.

SourceBytes long

The bytes of the two columns over the copied rows (TOTAL(LENGTH(…))).

FileBytes long

The archive file's length once complete; 0 when skipped.

PageSize int

The page size chosen for the file (16,384 or 4,096); 0 when skipped.

Elapsed TimeSpan

How long the gate, the sampling and the copy took.

FreeBytes long?

The free bytes the gate read on the result folder's drive; null when it could not be read (the copy then went ahead).

BoundBytes long

The step cache file's bytes (with its WAL): the upper bound the free space was compared with first.

NeededBytes long

The cold scan's estimate (the columns' bytes times the headroom) when the bound did not fit; 0 when the bound fit or the scan was not run.

ReservedBytes long

The bytes the gate kept free beyond the archive (ReserveBytes: the result file's completion).

Properties

BoundBytes

The step cache file's bytes (with its WAL): the upper bound the free space was compared with first.

public long BoundBytes { get; init; }

Property Value

long

Elapsed

How long the gate, the sampling and the copy took.

public TimeSpan Elapsed { get; init; }

Property Value

TimeSpan

EngagementRows

The rows whose engagement column is not NULL.

public long EngagementRows { get; init; }

Property Value

long

FileBytes

The archive file's length once complete; 0 when skipped.

public long FileBytes { get; init; }

Property Value

long

ForceRows

The rows whose force column is not NULL.

public long ForceRows { get; init; }

Property Value

long

FreeBytes

The free bytes the gate read on the result folder's drive; null when it could not be read (the copy then went ahead).

public long? FreeBytes { get; init; }

Property Value

long?

HeaderOnlyForceRows

The force rows stored as the no-cut record's 8-byte header (an untouched step under active physics).

public long HeaderOnlyForceRows { get; init; }

Property Value

long

NeededBytes

The cold scan's estimate (the columns' bytes times the headroom) when the bound did not fit; 0 when the bound fit or the scan was not run.

public long NeededBytes { get; init; }

Property Value

long

Outcome

Archived or Skipped.

public NcLuggageArchiveOutcome Outcome { get; init; }

Property Value

NcLuggageArchiveOutcome

PageSize

The page size chosen for the file (16,384 or 4,096); 0 when skipped.

public int PageSize { get; init; }

Property Value

int

ReservedBytes

The bytes the gate kept free beyond the archive (ReserveBytes: the result file's completion).

public long ReservedBytes { get; init; }

Property Value

long

Rows

The rows copied: every step cache row of the step range, the rows whose two columns are NULL included.

public long Rows { get; init; }

Property Value

long

SourceBytes

The bytes of the two columns over the copied rows (TOTAL(LENGTH(…))).

public long SourceBytes { get; init; }

Property Value

long