org.apache.paimon.mergetree

Interface WriteBuffer

All Known Implementing Classes:

SortBufferWriteBuffer

public interface WriteBuffer

Append only writer buffer for storing key-values. When it is full, it will be flushed to disk and form a data file.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WriteBuffer.KvConsumer A Consumer that accepts KeyValue and throw exceptions.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all records from this table.
boolean	flushMemory() Flush memory, return false if not supported.
void	forEach(Comparator<InternalRow> keyComparator, MergeFunction<KeyValue> mergeFunction, WriteBuffer.KvConsumer rawConsumer, WriteBuffer.KvConsumer mergedConsumer) Performs the given action for each remaining element in this buffer until all elements have been processed or the action throws an exception.
long	memoryOccupancy() Memory occupancy size of this table.
boolean	put(long sequenceNumber, RowKind valueKind, InternalRow key, InternalRow value) Put a record with sequence number and value kind.
int	size() Record size of this table.

Method Detail

put

boolean put(long sequenceNumber,
            RowKind valueKind,
            InternalRow key,
            InternalRow value)
     throws IOException

Put a record with sequence number and value kind.

Returns:

True, if the record was successfully written, false, if the mem table was full.

Throws:

IOException

size

int size()

Record size of this table.

memoryOccupancy

long memoryOccupancy()

Memory occupancy size of this table.

flushMemory

boolean flushMemory()
             throws IOException

Flush memory, return false if not supported.

Throws:

IOException

forEach

void forEach(Comparator<InternalRow> keyComparator,
             MergeFunction<KeyValue> mergeFunction,
             @Nullable
             WriteBuffer.KvConsumer rawConsumer,
             WriteBuffer.KvConsumer mergedConsumer)
      throws IOException

Performs the given action for each remaining element in this buffer until all elements have been processed or the action throws an exception.

Parameters:

rawConsumer - consumer to consume records without merging.

mergedConsumer - consumer to consume records after merging.

Throws:

IOException

clear

void clear()

Removes all records from this table. The table will be empty after this call returns.