Package org.apache.iceberg
Interface FileScanTask
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default FileScanTaskasFileScanTask()DataFilefile()Thefileto scan.default booleanisFileScanTask()longlength()The number of bytes to scan from thestart()position in the file.Expressionresidual()Returns the residual expression that should be applied to rows in this file scan.PartitionSpecspec()Thespecused to store this file.java.lang.Iterable<FileScanTask>split(long splitSize)Splits this scan task into componentscan tasks, each ofsplitSizesizelongstart()The starting position of this scan range in the file.-
Methods inherited from interface org.apache.iceberg.ScanTask
asCombinedScanTask, asDataTask, isDataTask
-
-
-
-
Method Detail
-
spec
PartitionSpec spec()
Thespecused to store this file.- Returns:
- the partition spec from this file's manifest
-
start
long start()
The starting position of this scan range in the file.- Returns:
- the start position of this scan range
-
length
long length()
The number of bytes to scan from thestart()position in the file.- Returns:
- the length of this scan range in bytes
-
residual
Expression residual()
Returns the residual expression that should be applied to rows in this file scan.The residual expression for a file is a filter expression created from the scan's filter, inclusive any predicates that are true or false for the entire file removed, based on the file's partition data.
- Returns:
- a residual expression to apply to rows from this scan
-
split
java.lang.Iterable<FileScanTask> split(long splitSize)
Splits this scan task into componentscan tasks, each ofsplitSizesize- Parameters:
splitSize- The size of a component scan task- Returns:
- an Iterable of
scan tasks
-
isFileScanTask
default boolean isFileScanTask()
- Specified by:
isFileScanTaskin interfaceScanTask- Returns:
- true if this is a
FileScanTask, false otherwise.
-
asFileScanTask
default FileScanTask asFileScanTask()
- Specified by:
asFileScanTaskin interfaceScanTask- Returns:
- this cast to
FileScanTaskif it is one
-
-