Package org.apache.iceberg

Interface DeletionVector

public interface DeletionVector

Metadata about a deletion vector.

Tracks where a DV blob can be read. The DV blob follows the format defined by the deletion-vector-v1 blob type in the Puffin spec.

Field Summary

Fields

Modifier and Type	Field	Description
static final Types.NestedField	CARDINALITY
static final Types.NestedField	KEY_METADATA
static final Types.NestedField	LOCATION
static final Types.NestedField	OFFSET
static final Types.NestedField	SIZE_IN_BYTES

Method Summary

Modifier and Type	Method	Description
long	cardinality()	Returns the number of set bits (deleted rows) in the vector.
DeletionVector	copy()	Copies this deletion vector.
ByteBuffer	keyMetadata()	Returns encryption key metadata, or null if the file is not encrypted.
String	location()	Returns the location of the file containing the deletion vector.
long	offset()	Returns the offset in the file where the deletion vector content starts.
static Types.StructType	schema()
long	sizeInBytes()	Returns the size in bytes of the deletion vector content.

Field Details

LOCATION

static final Types.NestedField LOCATION

OFFSET

static final Types.NestedField OFFSET

SIZE_IN_BYTES

static final Types.NestedField SIZE_IN_BYTES

CARDINALITY

static final Types.NestedField CARDINALITY

KEY_METADATA

static final Types.NestedField KEY_METADATA

Method Details

schema

static Types.StructType schema()

location

String location()

Returns the location of the file containing the deletion vector.

offset

long offset()

Returns the offset in the file where the deletion vector content starts.

sizeInBytes

long sizeInBytes()

Returns the size in bytes of the deletion vector content.

cardinality

long cardinality()

Returns the number of set bits (deleted rows) in the vector.

keyMetadata

ByteBuffer keyMetadata()

Returns encryption key metadata, or null if the file is not encrypted.

copy

DeletionVector copy()

Copies this deletion vector.