org.apache.iceberg

Interface ContentFile<F>

Type Parameters:

F - the concrete Java class of a ContentFile instance.

All Known Subinterfaces:

DataFile, DeleteFile

All Known Implementing Classes:

SparkDataFile

public interface ContentFile<F>

Superinterface of DataFile and DeleteFile that exposes common methods.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.Integer,java.lang.Long>	columnSizes()
FileContent	content()
F	copy() Copies this file.
F	copyWithoutStats() Copies this file without file stats.
long	fileSizeInBytes()
FileFormat	format()
java.nio.ByteBuffer	keyMetadata()
java.util.Map<java.lang.Integer,java.nio.ByteBuffer>	lowerBounds()
java.util.Map<java.lang.Integer,java.lang.Long>	nullValueCounts()
StructLike	partition()
java.lang.CharSequence	path()
long	recordCount()
java.util.List<java.lang.Long>	splitOffsets()
java.util.Map<java.lang.Integer,java.nio.ByteBuffer>	upperBounds()
java.util.Map<java.lang.Integer,java.lang.Long>	valueCounts()

Method Detail

content

FileContent content()

Returns:

type of content stored in the file; one of DATA, POSITION_DELETES, or EQUALITY_DELETES

path

java.lang.CharSequence path()

Returns:

fully qualified path to the file, suitable for constructing a Hadoop Path

format

FileFormat format()

Returns:

format of the file

partition

StructLike partition()

Returns:

partition for this file as a StructLike

recordCount

long recordCount()

Returns:

the number of top-level records in the file

fileSizeInBytes

long fileSizeInBytes()

Returns:

the file size in bytes

columnSizes

java.util.Map<java.lang.Integer,java.lang.Long> columnSizes()

Returns:

if collected, map from column ID to the size of the column in bytes, null otherwise

valueCounts

java.util.Map<java.lang.Integer,java.lang.Long> valueCounts()

Returns:

if collected, map from column ID to the count of its non-null values, null otherwise

nullValueCounts

java.util.Map<java.lang.Integer,java.lang.Long> nullValueCounts()

Returns:

if collected, map from column ID to its null value count, null otherwise

lowerBounds

java.util.Map<java.lang.Integer,java.nio.ByteBuffer> lowerBounds()

Returns:

if collected, map from column ID to value lower bounds, null otherwise

upperBounds

java.util.Map<java.lang.Integer,java.nio.ByteBuffer> upperBounds()

Returns:

if collected, map from column ID to value upper bounds, null otherwise

keyMetadata

java.nio.ByteBuffer keyMetadata()

Returns:

metadata about how this file is encrypted, or null if the file is stored in plain text.

splitOffsets

java.util.List<java.lang.Long> splitOffsets()

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.

copy

F copy()

Copies this file. Manifest readers can reuse file instances; use this method to copy data when collecting files from tasks.

Returns:

a copy of this data file

copyWithoutStats

F copyWithoutStats()

Copies this file without file stats. Manifest readers can reuse file instances; use this method to copy data without stats when collecting files.

Returns:

a copy of this data file, without lower bounds, upper bounds, value counts, or null value counts