Package org.apache.iceberg

Interface DeleteFile

All Superinterfaces:

ContentFile<DeleteFile>

All Known Implementing Classes:

SparkDeleteFile

public interface DeleteFile
extends ContentFile<DeleteFile>

Interface for delete files listed in a table delete manifest.

Method Summary

Modifier and Type	Method	Description
default Long	contentOffset()	Returns the offset in the file where the content starts.
default Long	contentSizeInBytes()	Returns the length of referenced content stored in the file.
default String	referencedDataFile()	Returns the location of a data file that all deletes reference.
default List<Long>	splitOffsets()	Returns list of recommended split locations, if applicable, null otherwise.

Methods inherited from interface org.apache.iceberg.ContentFile

columnSizes, content, copy, copy, copyWithoutStats, copyWithStats, dataSequenceNumber, equalityFieldIds, fileSequenceNumber, fileSizeInBytes, format, keyMetadata, location, lowerBounds, manifestLocation, nanValueCounts, nullValueCounts, partition, path, pos, recordCount, sortOrderId, specId, upperBounds, valueCounts

Method Details

splitOffsets

default List<Long> splitOffsets()

Description copied from interface: ContentFile

Returns list of recommended split locations, if applicable, null otherwise.

When available, this information is used for planning scan tasks whose boundaries are determined by these offsets. The returned list must be sorted in ascending order.

Specified by:

splitOffsets in interface ContentFile<DeleteFile>

Returns:

List of recommended split locations, if applicable, null otherwise. When available, this information is used for planning scan tasks whose boundaries are determined by these offsets. The returned list must be sorted in ascending order.

referencedDataFile

default String referencedDataFile()

Returns the location of a data file that all deletes reference.

The referenced data file is required for deletion vectors and may be optionally captured for position delete files that apply to only one data file. This method always returns null for equality delete files.

contentOffset

default Long contentOffset()

Returns the offset in the file where the content starts.

The content offset is required for deletion vectors and points to the start of the deletion vector blob in the Puffin file, enabling direct access. This method always returns null for equality and position delete files.

contentSizeInBytes

default Long contentSizeInBytes()

Returns the length of referenced content stored in the file.

The content size is required for deletion vectors and indicates the size of the deletion vector blob in the Puffin file, enabling direct access. This method always returns null for equality and position delete files.