Class ColumnFamilyHandle

Namespace

RocksDbNet

Assembly

RocksDb.Net.dll

A handle to a column family within a RocksDb database. Destroying this handle does not drop the column family from the database.

public class ColumnFamilyHandle : RocksDbHandle, IDisposable

Inheritance

object

RocksDbHandle

ColumnFamilyHandle

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)

Properties

Id

Numeric identifier for this column family.

public uint Id { get; }

Property Value

uint

Name

Name of this column family.

public string Name { get; }

Property Value

string

Remarks

The native accessor returns a fresh copy rather than a pointer into the handle, so the caller owns it. Reading this without freeing leaked the name on every access, and the database constructor reads it once per column family.

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

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.