Class FlushOptions

Namespace

RocksDbNet

Assembly

RocksDb.Net.dll

Options for Flush(FlushOptions?) operations.

public sealed class FlushOptions : RocksDbHandle, IDisposable

Inheritance

object

RocksDbHandle

FlushOptions

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

FlushOptions()

public FlushOptions()

Properties

AllowWriteStall

If true, the flush proceeds even when doing so would stall writes.

public bool AllowWriteStall { get; set; }

Property Value

bool

Remarks

If false, the default, the flush waits until it can run without causing a stall. It does not fail: the cost of saying no to a stall is that the call blocks for longer, not that it returns an error.

ForceAtomicFlush

If true, every column family is flushed together as one atomic unit, so the flushed files share a consistent view even across column families.

public bool ForceAtomicFlush { get; set; }

Property Value

bool

ListenerWait

If true, the flush call does not return until the registered EventListener callbacks for it have run. Useful when a test or a caller needs the notification to have been observed.

public bool ListenerWait { get; set; }

Property Value

bool

Wait

If true, the flush will wait until it completes before returning.

public bool Wait { 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().