Class BackupDrillOptions

Namespace

Typhon.Engine

Assembly

Typhon.Engine.dll

Options of Drill(string, PointSelector, BackupDrillOptions) (04 §6, plan 1416 §4.5).

public sealed class BackupDrillOptions

Inheritance

object

BackupDrillOptions

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

BackupDrillOptions()

public BackupDrillOptions()

Properties

Cancellation

Stops the drill: an Error, which says nothing about the point.

public CancellationToken Cancellation { get; init; }

Property Value

CancellationToken

KeepScratch

Leave the scratch bundle in place, for a look at what the drill opened.

public bool KeepScratch { get; init; }

Property Value

bool

Logger

The drill's log, and its engine's.

public ILogger Logger { get; init; }

Property Value

ILogger

OpenAndClose

Opens the restored bundle (recovery runs) and closes it cleanly; null = OpenAndCloseRestored(string, ILogger), which replays no record of the application's archetypes. An application drills a point whose tail holds them with b => BackupOperations.OpenAndCloseRestored(b, o => /* its registrations */). Whatever the opener does, the drill checks the result itself: a bundle not left clean, or an unclean image no recovery ran on, fails the open (the check never runs on an unrecovered image).

public Func<string, BackupSettleResult> OpenAndClose { get; init; }

Property Value

Func<string, BackupSettleResult>

PageCacheBytes

The page cache of the drill's engine, in bytes; 0 = the engine's default.

public ulong PageCacheBytes { get; init; }

Property Value

ulong

Progress

Stage, done, total (0, 0 = indeterminate): the restore's pages, the open, the check's own progress.

public Action<BackupDrillStage, long, long> Progress { get; init; }

Property Value

Action<BackupDrillStage, long, long>

Record

Write the drill's record into the store's drills/ (the history health and retention read).

public bool Record { get; init; }

Property Value

bool

ScratchDirectory

Where the point is restored: {ScratchDirectory}/{guid}/{name}.typhon, deleted when the drill ends. Required (DL-25), and refused inside the store: a mirror of the store would copy a whole image mid-drill. It needs the space of the whole image.

public required string ScratchDirectory { get; init; }

Property Value

string