Class BackupEngineOptions

Namespace

RocksDbNet

Assembly

RocksDb.Net.dll

Options for opening a BackupEngine. Maps to rocksdb_backup_engine_options_t.

public sealed class BackupEngineOptions : RocksDbHandle, IDisposable

Inheritance

object

RocksDbHandle

BackupEngineOptions

Implements

IDisposable

Inherited Members

RocksDbHandle.Handle

RocksDbHandle.Owned

RocksDbHandle.IsDisposed

RocksDbHandle.ThrowIfDisposed()

RocksDbHandle.Dispose()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

BackupEngineOptions(string)

Creates options for a backup engine rooted at backupDir.

public BackupEngineOptions(string backupDir)

Parameters

backupDir string

Properties

BackupDir

The directory backups are written to.

public string BackupDir { get; set; }

Property Value

string

BackupLogFiles

If true, WAL files are included in the backup.

public bool BackupLogFiles { get; set; }

Property Value

bool

BackupRateLimit

Backup throughput limit in bytes per second. 0 means unlimited.

public ulong BackupRateLimit { get; set; }

Property Value

ulong

CallbackTriggerIntervalSize

Bytes copied between invocations of the progress callback set on CreateBackupOptions.

public ulong CallbackTriggerIntervalSize { get; set; }

Property Value

ulong

CurrentTemperaturesOverrideManifest

If true, the file temperatures observed at backup time take precedence over the ones recorded in the manifest.

public bool CurrentTemperaturesOverrideManifest { get; set; }

Property Value

bool

DestroyOldData

If true, opening the engine deletes any backups already in the directory.

public bool DestroyOldData { get; set; }

Property Value

bool

IoBufferSize

Size in bytes of the buffer used to copy file contents. 0 lets RocksDb choose.

public ulong IoBufferSize { get; set; }

Property Value

ulong

MaxBackgroundOperations

Number of threads used to copy files during a backup or restore.

public int MaxBackgroundOperations { get; set; }

Property Value

int

RestoreRateLimit

Restore throughput limit in bytes per second. 0 means unlimited.

public ulong RestoreRateLimit { get; set; }

Property Value

ulong

SchemaVersion

On-disk schema version for new backups. Newer versions support more features but cannot be read by older RocksDb releases.

public int SchemaVersion { get; set; }

Property Value

int

ShareFilesWithChecksum

If true, shared files are named and matched by checksum as well as size, which detects a corrupt shared file that happens to be the right length.

public bool ShareFilesWithChecksum { get; set; }

Property Value

bool

ShareFilesWithChecksumNaming

How shared file names encode their checksum. RocksDb does not publish these values through the C API, so this stays an int.

public int ShareFilesWithChecksumNaming { get; set; }

Property Value

int

ShareTableFiles

If true, table files are shared between backups instead of copied into each one, which makes incremental backups much cheaper.

public bool ShareTableFiles { get; set; }

Property Value

bool

Sync

If true, each backup is synced to durable storage before it is reported complete.

public bool Sync { get; set; }

Property Value

bool

Methods

DisposeHandle()

Releases the native handle. Called during disposal.

protected override void DisposeHandle()

Remarks

Protected rather than public: it destroys the native object without marking this instance disposed or clearing the handle, so calling it from outside and then disposing normally would free the same pointer twice. It was the most Dispose-looking member on the type. Callers want Dispose().

SetBackupRateLimiter(RateLimiter?)

Throttles backup I/O using a rate limiter object.

public BackupEngineOptions SetBackupRateLimiter(RateLimiter? rateLimiter)

Parameters

rateLimiter RateLimiter

Returns

BackupEngineOptions

Remarks

Write-only, since the C API offers no getter. RocksDb copies the shared pointer rather than taking ownership, so the caller stays responsible for disposing rateLimiter and must keep it alive while the engine is in use. Prefer this over BackupRateLimit when the limiter is shared with other work.

Passing null does nothing rather than removing an existing limiter, because the C API ignores a null argument.

SetEnv(Env?)

Selects the environment the engine reads and writes through.

public BackupEngineOptions SetEnv(Env? env)

Parameters

env Env

Returns

BackupEngineOptions

SetRestoreRateLimiter(RateLimiter?)

Throttles restore I/O using a rate limiter object.

public BackupEngineOptions SetRestoreRateLimiter(RateLimiter? rateLimiter)

Parameters

rateLimiter RateLimiter

Returns

BackupEngineOptions

Remarks

Ownership works exactly as for SetBackupRateLimiter(RateLimiter?), and so does the treatment of null: it is ignored, not a way to remove a limiter.