org.apache.paimon.deletionvectors

Class DeletionVectorsIndexFile

java.lang.Object

org.apache.paimon.index.IndexFile

org.apache.paimon.deletionvectors.DeletionVectorsIndexFile

public class DeletionVectorsIndexFile
extends IndexFile

DeletionVectors index file.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DELETION_VECTORS_INDEX
static byte	VERSION_ID_V1

Fields inherited from class org.apache.paimon.index.IndexFile

fileIO, pathFactory

Constructor Summary

Constructors

Constructor and Description
DeletionVectorsIndexFile(FileIO fileIO, PathFactory pathFactory, MemorySize targetSizePerIndexFile)

Method Summary

Modifier and Type	Method and Description
static int	calculateChecksum(byte[] bytes)
Map<String,DeletionVector>	readAllDeletionVectors(IndexFileMeta fileMeta) Reads all deletion vectors from a specified file.
Map<String,DeletionVector>	readAllDeletionVectors(List<IndexFileMeta> indexFiles)
DeletionVector	readDeletionVector(DeletionFile deletionFile)
Map<String,DeletionVector>	readDeletionVector(Map<String,DeletionFile> dataFileToDeletionFiles) Reads deletion vectors from a list of DeletionFile which belong to a same index file.
List<IndexFileMeta>	write(Map<String,DeletionVector> input) Write deletion vectors to a new file, the format of this file can be referenced at: PIP-16.

Methods inherited from class org.apache.paimon.index.IndexFile

delete, exists, fileSize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DELETION_VECTORS_INDEX

public static final String DELETION_VECTORS_INDEX

See Also:

Constant Field Values

VERSION_ID_V1

public static final byte VERSION_ID_V1

See Also:

Constant Field Values

Constructor Detail

DeletionVectorsIndexFile

public DeletionVectorsIndexFile(FileIO fileIO,
                                PathFactory pathFactory,
                                MemorySize targetSizePerIndexFile)

Method Detail

readAllDeletionVectors

public Map<String,DeletionVector> readAllDeletionVectors(IndexFileMeta fileMeta)

Reads all deletion vectors from a specified file.

Returns:

A map where the key represents which file the DeletionVector belongs to, and the value is the corresponding DeletionVector object.

Throws:

UncheckedIOException - If an I/O error occurs while reading from the file.

readAllDeletionVectors

public Map<String,DeletionVector> readAllDeletionVectors(List<IndexFileMeta> indexFiles)

readDeletionVector

public Map<String,DeletionVector> readDeletionVector(Map<String,DeletionFile> dataFileToDeletionFiles)

Reads deletion vectors from a list of DeletionFile which belong to a same index file.

readDeletionVector

public DeletionVector readDeletionVector(DeletionFile deletionFile)

write

public List<IndexFileMeta> write(Map<String,DeletionVector> input)

Write deletion vectors to a new file, the format of this file can be referenced at: PIP-16.

Parameters:

input - A map where the key represents which file the DeletionVector belongs to, and the value is the corresponding DeletionVector object.

Returns:

A Pair object specifying the name of the written new file and a map where the key represents which file the DeletionVector belongs to and the value is a Pair object specifying the range (start position and size) within the file where the deletion vector data is located.

Throws:

UncheckedIOException - If an I/O error occurs while writing to the file.

calculateChecksum

public static int calculateChecksum(byte[] bytes)