Class ColumnFamilyMetadataOptions

Namespace

RocksDbNet

Assembly

RocksDb.Net.dll

Narrows what GetColumnFamilyMetadata(ColumnFamilyMetadataOptions) reports, by level and by key range. Maps to rocksdb_column_family_metadata_options_t.

public sealed class ColumnFamilyMetadataOptions : RocksDbHandle, IDisposable

Inheritance

object

RocksDbHandle

ColumnFamilyMetadataOptions

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

Remarks

Useful on a large database, where collecting metadata for every level and every file is far more work than the caller needs.

Constructors

ColumnFamilyMetadataOptions()

public ColumnFamilyMetadataOptions()

Properties

EndKey

Exclusive upper bound on the keys of interest, or null when unbounded. Assigning an empty span clears the bound.

public byte[]? EndKey { get; set; }

Property Value

byte[]

Level

Restricts the result to this LSM level. A negative value, the default, covers every level.

public int Level { get; set; }

Property Value

int

StartKey

Inclusive lower bound on the keys of interest, or null when unbounded. Assigning an empty span clears the bound.

public byte[]? StartKey { get; set; }

Property Value

byte[]

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

SetEndKey(ReadOnlySpan<byte>)

Sets the exclusive upper bound on the keys of interest.

public ColumnFamilyMetadataOptions SetEndKey(ReadOnlySpan<byte> key)

Parameters

key ReadOnlySpan<byte>

Returns

ColumnFamilyMetadataOptions

SetStartKey(ReadOnlySpan<byte>)

Sets the inclusive lower bound on the keys of interest.

public ColumnFamilyMetadataOptions SetStartKey(ReadOnlySpan<byte> key)

Parameters

key ReadOnlySpan<byte>

Returns

ColumnFamilyMetadataOptions