Class WalFile

Namespace

RocksDbNet

Assembly

RocksDb.Net.dll

Describes one write-ahead log file. Copied from rocksdb_wal_file_t.

public sealed record WalFile : IEquatable<WalFile>

Inheritance

object

WalFile

Implements

IEquatable<WalFile>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

This is a snapshot rather than a handle, deliberately. RocksDb's ownership of WAL file objects is asymmetric: entries from GetSortedWalFiles() are borrowed from a vector and must not be freed individually, while GetCurrentWalFile() returns one the caller owns. Copying the values out means callers never have to know which they hold.

Properties

LogNumber

The log number, which increases as WAL files are rotated.

public ulong LogNumber { get; init; }

Property Value

ulong

PathName

Path of the file, relative to the WAL directory.

public string? PathName { get; init; }

Property Value

string

SizeFileBytes

Size of the file in bytes.

public ulong SizeFileBytes { get; init; }

Property Value

ulong

StartSequence

Sequence number of the first record in the file.

public ulong StartSequence { get; init; }

Property Value

ulong

Type

Whether the file is live or archived.

public WalFileType Type { get; init; }

Property Value

WalFileType