Class CompactionJobInfo

Namespace

RocksDbNet

Assembly

RocksDb.Net.dll

Information about a completed compaction job.

public sealed record CompactionJobInfo : IEquatable<CompactionJobInfo>

Inheritance

object

CompactionJobInfo

Implements

IEquatable<CompactionJobInfo>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CompactionJobInfo(string?, string[], string[], ulong, ulong, ulong, ulong, TimeSpan, ulong, int, CompactionReason, string?)

Information about a completed compaction job.

public CompactionJobInfo(string? ColumnFamilyName, string[] InputFiles, string[] OutputFiles, ulong TotalInputBytes, ulong TotalOutputBytes, ulong InputRecords, ulong OutputRecords, TimeSpan Elapsed, ulong NumOfCorruptKeys, int BaseInputLevel, CompactionReason CompactionReason, string? Status)

Parameters

ColumnFamilyName string

InputFiles string[]

OutputFiles string[]

TotalInputBytes ulong

TotalOutputBytes ulong

InputRecords ulong

OutputRecords ulong

Elapsed TimeSpan

NumOfCorruptKeys ulong

BaseInputLevel int

CompactionReason CompactionReason

Status string

Properties

Aborted

true when the compaction was cancelled or otherwise did not finish. The other values describe however much work it did before stopping.

public bool Aborted { get; init; }

Property Value

bool

BaseInputLevel

public int BaseInputLevel { get; init; }

Property Value

int

BlobCompressionType

Compression applied to any blob files this compaction wrote.

public Compression BlobCompressionType { get; init; }

Property Value

Compression

BlobFileAdditions

Blob files created by this compaction. Empty when blob files are disabled.

public IReadOnlyList<BlobFileAdditionInfo> BlobFileAdditions { get; init; }

Property Value

IReadOnlyList<BlobFileAdditionInfo>

BlobFileGarbage

Blob-file garbage discovered by this compaction.

public IReadOnlyList<BlobFileGarbageInfo> BlobFileGarbage { get; init; }

Property Value

IReadOnlyList<BlobFileGarbageInfo>

ColumnFamilyId

Identifier of the column family that was compacted.

public uint ColumnFamilyId { get; init; }

Property Value

uint

ColumnFamilyName

public string? ColumnFamilyName { get; init; }

Property Value

string

CompactionReason

public CompactionReason CompactionReason { get; init; }

Property Value

CompactionReason

Compression

Compression applied to the SST files this compaction wrote.

public Compression Compression { get; init; }

Property Value

Compression

Elapsed

public TimeSpan Elapsed { get; init; }

Property Value

TimeSpan

InputFileInfos

Level and file number for each input file.

public IReadOnlyList<CompactionFileInfo> InputFileInfos { get; init; }

Property Value

IReadOnlyList<CompactionFileInfo>

InputFiles

public string[] InputFiles { get; init; }

Property Value

string[]

InputRecords

public ulong InputRecords { get; init; }

Property Value

ulong

JobId

Identifier of the compaction job, unique within the database's lifetime.

public int JobId { get; init; }

Property Value

int

NumL0Files

Number of level-0 files in the column family around the time of the compaction. RocksDb documents this as the count "right before and after" the compaction, and in practice a compaction that drains level 0 reports 0 here.

public int NumL0Files { get; init; }

Property Value

int

NumOfCorruptKeys

public ulong NumOfCorruptKeys { get; init; }

Property Value

ulong

OutputFileInfos

Level and file number for each output file.

public IReadOnlyList<CompactionFileInfo> OutputFileInfos { get; init; }

Property Value

IReadOnlyList<CompactionFileInfo>

OutputFiles

public string[] OutputFiles { get; init; }

Property Value

string[]

OutputRecords

public ulong OutputRecords { get; init; }

Property Value

ulong

Stats

Detailed statistics for the compaction, or null if RocksDb reported none. Supersedes the individual totals on this record, which remain for compatibility.

public CompactionJobStats? Stats { get; init; }

Property Value

CompactionJobStats

Status

public string? Status { get; init; }

Property Value

string

TablePropertiesByFile

Table properties for the files involved, keyed by file name. RocksDb includes both inputs and outputs.

public IReadOnlyDictionary<string, TableProperties> TablePropertiesByFile { get; init; }

Property Value

IReadOnlyDictionary<string, TableProperties>

ThreadId

Identifier of the RocksDb background thread that ran the compaction.

public ulong ThreadId { get; init; }

Property Value

ulong

TotalInputBytes

public ulong TotalInputBytes { get; init; }

Property Value

ulong

TotalOutputBytes

public ulong TotalOutputBytes { get; init; }

Property Value

ulong