Class RestoreOptions

Namespace

RocksDbNet

Assembly

RocksDb.Net.dll

Options for restoring a database from a backup. Maps to rocksdb_restore_options_t.

public sealed class RestoreOptions : RocksDbHandle, IDisposable

Inheritance

object

RocksDbHandle

RestoreOptions

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

RestoreOptions()

public RestoreOptions()

Properties

KeepLogFiles

If true, existing WAL files in the destination are kept rather than overwritten, and archived logs are moved into the WAL directory.

public bool KeepLogFiles { get; set; }

Property Value

bool

Mode

How thoroughly the restore replaces files already in the destination. Defaults to PurgeAllFiles.

public RestoreMode Mode { get; set; }

Property Value

RestoreMode

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().