Interface IBackupService

Namespace: Typhon.Engine

Assembly: Typhon.Engine.dll

Online backup of a running database (Backup): a consistent point taken while the engine keeps committing, one at a time, on the engine's backup thread. Scheduling and retention are the application's until the engine's scheduler arrives (#1416).

public interface IBackupService

Remarks

Failures: a BackupAbortedException when the capture was abandoned, its Reason saying why (cancelled, the engine closing, a writer the backup could not keep up with, the store failing). An abandoned point publishes nothing and forgets no page: the next point covers it. A TyphonException with BackupInProgress when a backup is already running. The store's own refusals are the typed BackupStoreLockedException and BackupStoreMismatchException.

Methods

CreateAsync(string, BackupRequestKind, CancellationToken)

Takes a backup point of the running database into the store at storePath (created when absent).

Task<BackupPointSummary> CreateAsync(string storePath, BackupRequestKind kind = BackupRequestKind.Auto, CancellationToken ct = default)

Parameters

storePath string: The store directory; it belongs to this database once it holds a point.
kind BackupRequestKind: Auto (admission decides) or a forced full point.
ct CancellationToken: Abandons the capture: nothing is published.

Returns