Class CompactionFilterFactory

Namespace

RocksDbNet

Assembly

RocksDb.Net.dll

Creates a fresh CompactionFilter for each compaction / flush job. Preferred over sharing a single filter instance when the filter contains per-compaction state or when thread-safe access to a shared instance is not practical.

public abstract class CompactionFilterFactory : RocksDbHandle, IDisposable

Inheritance

object

RocksDbHandle

CompactionFilterFactory

Implements

IDisposable

Inherited Members

RocksDbHandle.Handle

RocksDbHandle.Owned

RocksDbHandle.IsDisposed

RocksDbHandle.PinGarbageCollector(string)

RocksDbHandle.IsPinned

RocksDbHandle.GetPinnedIntPtr()

RocksDbHandle.GetPinnedNameIntPtr()

RocksDbHandle.UnpinGarbageCollector()

RocksDbHandle.GetSelfFromPinnedIntPtr<T>(nint)

RocksDbHandle.GetNameFromPinnedIntPtr(nint)

RocksDbHandle.ThrowIfDisposed()

RocksDbHandle.Dispose()

RocksDbHandle.Dispose(bool)

RocksDbHandle.DisposeUnmanagedResources()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Lifetime: After passing the factory to CompactionFilterFactory, the C++ options object shares ownership of it through a shared_ptr. Disposing the factory is safe at any point: attaching registers a hold, so a using block that ends first defers the release rather than performing it.

Constructors

CompactionFilterFactory(string)

protected CompactionFilterFactory(string name)

Parameters

name string

Methods

CreateFilter(CompactionFilterContext)

Creates a new CompactionFilter for the given compaction job. Return a freshly constructed instance on every call; do not share instances between jobs. RocksDb owns the returned filter's lifetime — do not dispose the returned filter.

protected abstract CompactionFilter CreateFilter(CompactionFilterContext context)

Parameters

context CompactionFilterContext

Returns

CompactionFilter

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