Class AsyncCompressedFileSystemWriteAheadLog<TKey, TValue>

Inheritance

object

AsyncCompressedFileSystemWriteAheadLog<TKey, TValue>

Implements

IWriteAheadLog<TKey, TValue>

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Tenray.ZoneTree.WAL

Assembly: ZoneTree.dll

Syntax

public sealed class AsyncCompressedFileSystemWriteAheadLog<TKey, TValue> : IWriteAheadLog<TKey, TValue>, IDisposable

Type Parameters

Name	Description
TKey
TValue

Constructors

| Improve this Doc View Source

AsyncCompressedFileSystemWriteAheadLog(ILogger, IFileStreamProvider, ISerializer<TKey>, ISerializer<TValue>, string, WriteAheadLogOptions)

Declaration

public AsyncCompressedFileSystemWriteAheadLog(ILogger logger, IFileStreamProvider fileStreamProvider, ISerializer<TKey> keySerializer, ISerializer<TValue> valueSerializer, string filePath, WriteAheadLogOptions options)

Parameters

Type	Name	Description
ILogger	logger
IFileStreamProvider	fileStreamProvider
ISerializer<TKey>	keySerializer
ISerializer<TValue>	valueSerializer
string	filePath
WriteAheadLogOptions	options

Properties

| Improve this Doc View Source

EnableIncrementalBackup

Declaration

public bool EnableIncrementalBackup { get; set; }

Property Value

Type	Description
bool

| Improve this Doc View Source

FilePath

Declaration

public string FilePath { get; }

Property Value

Type	Description
string

| Improve this Doc View Source

InitialLength

The initial record count of the log. It is available after the ReadLogEntries call.

Declaration

public int InitialLength { get; }

Property Value

Type	Description
int

Methods

| Improve this Doc View Source

Append(in TKey, in TValue, long)

Declaration

public void Append(in TKey key, in TValue value, long opIndex)

Parameters

Type	Name	Description
TKey	key
TValue	value
long	opIndex

| Improve this Doc View Source

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

| Improve this Doc View Source

Drop()

Declaration

public void Drop()

| Improve this Doc View Source

MarkFrozen()

Informs the write ahead log that no further writes will be sent. to let WAL optimize itself.

Declaration

public void MarkFrozen()

| Improve this Doc View Source

ReadLogEntries(bool, bool, bool)

Declaration

public WriteAheadLogReadLogEntriesResult<TKey, TValue> ReadLogEntries(bool stopReadOnException, bool stopReadOnChecksumFailure, bool sortByOpIndexes)

Parameters

Type	Name	Description
bool	stopReadOnException
bool	stopReadOnChecksumFailure
bool	sortByOpIndexes

Returns

Type	Description
WriteAheadLogReadLogEntriesResult<TKey, TValue>

| Improve this Doc View Source

ReplaceWriteAheadLog(TKey[], TValue[], bool)

Replaces the entire write ahead log, with given keys and values. If enabled, appends current wal data to the incremental backup log.

Declaration

public long ReplaceWriteAheadLog(TKey[] keys, TValue[] values, bool disableBackup)

Parameters

Type	Name	Description
TKey[]	keys	new keys
TValue[]	values	new values
bool	disableBackup	disable backup regardless of wal flag.

Returns

Type	Description
long	the difference: old file length - new file length.

| Improve this Doc View Source

TruncateIncompleteTailRecord(IncompleteTailRecordFoundException)

Truncates incomplete tail record.

Declaration

public void TruncateIncompleteTailRecord(IncompleteTailRecordFoundException incompleteTailException)

Parameters

Type	Name	Description
IncompleteTailRecordFoundException	incompleteTailException

Implements

IWriteAheadLog<TKey, TValue>

IDisposable