Class ColumnFamilyMetadata

Namespace

RocksDbNet

Assembly

RocksDb.Net.dll

Metadata describing a column family, including its size and the levels currently stored.

public sealed record ColumnFamilyMetadata : IEquatable<ColumnFamilyMetadata>

Inheritance

object

ColumnFamilyMetadata

Implements

IEquatable<ColumnFamilyMetadata>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

A snapshot, read in full before it is handed over, so it needs no disposal and can be kept and passed around freely. It used to read through a native handle on every property access, which meant an instance was only valid while that handle was alive and made the whole graph disposable. See the ownership guide for why this library copies rather than lending.

Constructors

ColumnFamilyMetadata(string, ulong, int, int, IReadOnlyList<ColumnFamilyLevelMetadata>)

Metadata describing a column family, including its size and the levels currently stored.

public ColumnFamilyMetadata(string Name, ulong Size, int FileCount, int LevelCount, IReadOnlyList<ColumnFamilyLevelMetadata> Levels)

Parameters

Name string

The name of the column family.

Size ulong

Total size in bytes of the files belonging to it.

FileCount int

How many SST files it holds.

LevelCount int

How many LSM levels it has.

Levels IReadOnlyList<ColumnFamilyLevelMetadata>

Metadata for each level.

Remarks

A snapshot, read in full before it is handed over, so it needs no disposal and can be kept and passed around freely. It used to read through a native handle on every property access, which meant an instance was only valid while that handle was alive and made the whole graph disposable. See the ownership guide for why this library copies rather than lending.

Properties

FileCount

How many SST files it holds.

public int FileCount { get; init; }

Property Value

int

LevelCount

How many LSM levels it has.

public int LevelCount { get; init; }

Property Value

int

Levels

Metadata for each level.

public IReadOnlyList<ColumnFamilyLevelMetadata> Levels { get; init; }

Property Value

IReadOnlyList<ColumnFamilyLevelMetadata>

Name

The name of the column family.

public string Name { get; init; }

Property Value

string

Size

Total size in bytes of the files belonging to it.

public ulong Size { get; init; }

Property Value

ulong