org.apache.paimon.deletionvectors

Interface DeletionVector

All Known Implementing Classes:

BitmapDeletionVector

public interface DeletionVector

The DeletionVector can efficiently record the positions of rows that are deleted in a file, which can then be used to filter out deleted rows when processing the file.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DeletionVector.Factory Interface to create DeletionVector.

Method Summary

Modifier and Type	Method and Description
default boolean	checkedDelete(long position) Marks the row at the specified position as deleted.
void	delete(long position) Marks the row at the specified position as deleted.
static DeletionVector	deserializeFromBytes(byte[] bytes) Deserializes a deletion vector from a byte array.
static DeletionVector.Factory	emptyFactory()
static DeletionVector.Factory	factory(DeletionVectorsMaintainer dvMaintainer)
static DeletionVector.Factory	factory(FileIO fileIO, List<DataFileMeta> files, List<DeletionFile> deletionFiles)
long	getCardinality()
boolean	isDeleted(long position) Checks if the row at the specified position is marked as deleted.
boolean	isEmpty() Determines if the deletion vector is empty, indicating no deletions.
void	merge(DeletionVector deletionVector) merge another DeletionVector to this current one.
static DeletionVector	read(FileIO fileIO, DeletionFile deletionFile)
byte[]	serializeToBytes() Serializes the deletion vector to a byte array for storage or transmission.

Method Detail

delete

void delete(long position)

Marks the row at the specified position as deleted.

Parameters:

position - The position of the row to be marked as deleted.

merge

void merge(DeletionVector deletionVector)

merge another DeletionVector to this current one.

Parameters:

deletionVector - the other DeletionVector

checkedDelete

default boolean checkedDelete(long position)

Marks the row at the specified position as deleted.

Parameters:

position - The position of the row to be marked as deleted.

Returns:

true if the added position wasn't already deleted. False otherwise.

isDeleted

boolean isDeleted(long position)

Checks if the row at the specified position is marked as deleted.

Parameters:

position - The position of the row to check.

Returns:

true if the row is marked as deleted, false otherwise.

isEmpty

boolean isEmpty()

Determines if the deletion vector is empty, indicating no deletions.

Returns:

true if the deletion vector is empty, false if it contains deletions.

getCardinality

long getCardinality()

Returns:

the number of distinct integers added to the DeletionVector.

serializeToBytes

byte[] serializeToBytes()

Serializes the deletion vector to a byte array for storage or transmission.

Returns:

A byte array representing the serialized deletion vector.

deserializeFromBytes

static DeletionVector deserializeFromBytes(byte[] bytes)

Deserializes a deletion vector from a byte array.

Parameters:

bytes - The byte array containing the serialized deletion vector.

Returns:

A DeletionVector instance that represents the deserialized data.

read

static DeletionVector read(FileIO fileIO,
                           DeletionFile deletionFile)
                    throws IOException

Throws:

IOException

emptyFactory

static DeletionVector.Factory emptyFactory()

factory

static DeletionVector.Factory factory(@Nullable
                                      DeletionVectorsMaintainer dvMaintainer)

factory

static DeletionVector.Factory factory(FileIO fileIO,
                                      List<DataFileMeta> files,
                                      @Nullable
                                      List<DeletionFile> deletionFiles)