Package org.apache.iceberg
Class AllFilesTable.AllFilesTableScan
- java.lang.Object
-
- org.apache.iceberg.SnapshotScan<TableScan,FileScanTask,CombinedScanTask>
-
- org.apache.iceberg.AllFilesTable.AllFilesTableScan
-
- All Implemented Interfaces:
Scan<TableScan,FileScanTask,CombinedScanTask>
,TableScan
- Enclosing class:
- AllFilesTable
public static class AllFilesTable.AllFilesTableScan extends SnapshotScan<TableScan,FileScanTask,CombinedScanTask>
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.util.List<java.lang.String>
DELETE_SCAN_COLUMNS
protected static java.util.List<java.lang.String>
DELETE_SCAN_WITH_STATS_COLUMNS
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TableScan
appendsAfter(long fromSnapshotId)
Create a newTableScan
to read appended data fromfromSnapshotId
exclusive to the current snapshot inclusive.TableScan
appendsBetween(long fromSnapshotId, long toSnapshotId)
Create a newTableScan
to read appended data fromfromSnapshotId
exclusive totoSnapshotId
inclusive.TableScan
asOfTime(long timestampMillis)
Create a newTableScan
from this scan's configuration that will use the most recent snapshot as of the given time in milliseconds on the branch in the scan or main if no branch is set.ThisT
caseSensitive(boolean caseSensitive)
Create a new scan from this that, if data columns where selected viaScan.select(java.util.Collection)
, controls whether the match to the schema will be done with case sensitivity.protected org.apache.iceberg.TableScanContext
context()
protected CloseableIterable<FileScanTask>
doPlanFiles()
Expression
filter()
Returns this scan's filterExpression
.ThisT
filter(Expression expr)
Create a new scan from the results of this filtered by theExpression
.ThisT
ignoreResiduals()
Create a new scan from this that applies data filtering to files but not to rows in those files.ThisT
includeColumnStats()
Create a new scan from this that loads the column stats with each data file.boolean
isCaseSensitive()
Returns whether this scan is case-sensitive with respect to column names.protected CloseableIterable<ManifestFile>
manifests()
Returns an iterable of manifest files to explore for this all files metadata table scanprotected ThisT
newRefinedScan(TableOperations ignored, Table newTable, Schema newSchema, org.apache.iceberg.TableScanContext newContext)
Deprecated.will be removed in 1.3.0; use newRefinedScan(Table, Schema, TableScanContext) instead.protected TableScan
newRefinedScan(Table table, Schema schema, org.apache.iceberg.TableScanContext context)
ThisT
option(java.lang.String property, java.lang.String value)
Create a new scan from this scan's configuration that will override theTable
's behavior based on the incoming pair.protected java.util.Map<java.lang.String,java.lang.String>
options()
protected java.util.concurrent.ExecutorService
planExecutor()
CloseableIterable<FileScanTask>
planFiles()
Plan tasks for this scan where each task reads a single file.CloseableIterable<CombinedScanTask>
planTasks()
Plan balanced task groups for this scan by splitting large and combining small tasks.ThisT
planWith(java.util.concurrent.ExecutorService executorService)
Create a new scan to use a particular executor to plan.ThisT
project(Schema projectedSchema)
Create a new scan from this with the schema as its projection.protected CloseableIterable<ManifestFile>
reachableManifests(org.apache.iceberg.relocated.com.google.common.base.Function<Snapshot,java.lang.Iterable<ManifestFile>> toManifests)
protected java.util.List<java.lang.String>
scanColumns()
Schema
schema()
Returns this scan's projectionSchema
.ThisT
select(java.util.Collection<java.lang.String> columns)
Create a new scan from this that will read the given data columns.protected boolean
shouldIgnoreResiduals()
protected boolean
shouldPlanWithExecutor()
int
splitLookback()
Returns the split lookback for this scan.long
splitOpenFileCost()
Returns the split open file cost for this scan.Table
table()
protected TableOperations
tableOps()
Deprecated.will be removed in 1.3.0; avoid using TableOperations for scans or use BaseTableprotected Schema
tableSchema()
protected MetadataTableType
tableType()
Type of scan being performed, such asMetadataTableType.ALL_DATA_FILES
when scanning a table'sAllDataFilesTable
.long
targetSplitSize()
Returns the target split size for this scan.TableScan
useRef(java.lang.String ref)
Create a newTableScan
from this scan's configuration that will use the given reference.TableScan
useSnapshot(long scanSnapshotId)
Create a newTableScan
from this scan's configuration that will use the given snapshot by ID.-
Methods inherited from class org.apache.iceberg.SnapshotScan
scanMetrics, snapshot, snapshotId, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.iceberg.Scan
caseSensitive, filter, filter, ignoreResiduals, includeColumnStats, isCaseSensitive, option, planWith, project, schema, select, select, splitLookback, splitOpenFileCost
-
-
-
-
Method Detail
-
newRefinedScan
protected TableScan newRefinedScan(Table table, Schema schema, org.apache.iceberg.TableScanContext context)
-
manifests
protected CloseableIterable<ManifestFile> manifests()
Returns an iterable of manifest files to explore for this all files metadata table scan
-
doPlanFiles
protected CloseableIterable<FileScanTask> doPlanFiles()
- Specified by:
doPlanFiles
in classSnapshotScan<TableScan,FileScanTask,CombinedScanTask>
-
useSnapshot
public TableScan useSnapshot(long scanSnapshotId)
Description copied from interface:TableScan
Create a newTableScan
from this scan's configuration that will use the given snapshot by ID.- Specified by:
useSnapshot
in interfaceTableScan
- Overrides:
useSnapshot
in classSnapshotScan<TableScan,FileScanTask,CombinedScanTask>
- Parameters:
scanSnapshotId
- a snapshot ID- Returns:
- a new scan based on this with the given snapshot ID
-
useRef
public TableScan useRef(java.lang.String ref)
Description copied from interface:TableScan
Create a newTableScan
from this scan's configuration that will use the given reference.- Specified by:
useRef
in interfaceTableScan
- Overrides:
useRef
in classSnapshotScan<TableScan,FileScanTask,CombinedScanTask>
- Parameters:
ref
- reference- Returns:
- a new scan based on the given reference.
-
asOfTime
public TableScan asOfTime(long timestampMillis)
Description copied from interface:TableScan
Create a newTableScan
from this scan's configuration that will use the most recent snapshot as of the given time in milliseconds on the branch in the scan or main if no branch is set.- Specified by:
asOfTime
in interfaceTableScan
- Overrides:
asOfTime
in classSnapshotScan<TableScan,FileScanTask,CombinedScanTask>
- Parameters:
timestampMillis
- a timestamp in milliseconds.- Returns:
- a new scan based on this with the current snapshot at the given time
-
planFiles
public CloseableIterable<FileScanTask> planFiles()
Description copied from interface:Scan
Plan tasks for this scan where each task reads a single file.Use
Scan.planTasks()
for planning balanced tasks where each task will read either a single file, a part of a file, or multiple files.- Specified by:
planFiles
in interfaceScan<TableScan,FileScanTask,CombinedScanTask>
- Overrides:
planFiles
in classSnapshotScan<TableScan,FileScanTask,CombinedScanTask>
- Returns:
- an Iterable of tasks scanning entire files required by this scan
-
reachableManifests
protected CloseableIterable<ManifestFile> reachableManifests(org.apache.iceberg.relocated.com.google.common.base.Function<Snapshot,java.lang.Iterable<ManifestFile>> toManifests)
-
tableType
protected MetadataTableType tableType()
Type of scan being performed, such asMetadataTableType.ALL_DATA_FILES
when scanning a table'sAllDataFilesTable
.Used for logging and error messages.
-
appendsBetween
public TableScan appendsBetween(long fromSnapshotId, long toSnapshotId)
Description copied from interface:TableScan
Create a newTableScan
to read appended data fromfromSnapshotId
exclusive totoSnapshotId
inclusive.- Specified by:
appendsBetween
in interfaceTableScan
- Parameters:
fromSnapshotId
- the last snapshot id read by the user, exclusivetoSnapshotId
- read append data up to this snapshot id- Returns:
- a table scan which can read append data from
fromSnapshotId
exclusive and up totoSnapshotId
inclusive
-
appendsAfter
public TableScan appendsAfter(long fromSnapshotId)
Description copied from interface:TableScan
Create a newTableScan
to read appended data fromfromSnapshotId
exclusive to the current snapshot inclusive.- Specified by:
appendsAfter
in interfaceTableScan
- Parameters:
fromSnapshotId
- - the last snapshot id read by the user, exclusive- Returns:
- a table scan which can read append data from
fromSnapshotId
exclusive and up to current snapshot inclusive
-
targetSplitSize
public long targetSplitSize()
Description copied from interface:Scan
Returns the target split size for this scan.- Specified by:
targetSplitSize
in interfaceScan<TableScan,FileScanTask,CombinedScanTask>
-
planTasks
public CloseableIterable<CombinedScanTask> planTasks()
Description copied from interface:Scan
Plan balanced task groups for this scan by splitting large and combining small tasks.Task groups created by this method may read partial input files, multiple input files or both.
- Specified by:
planTasks
in interfaceScan<TableScan,FileScanTask,CombinedScanTask>
- Returns:
- an Iterable of balanced task groups required by this scan
-
tableOps
@Deprecated protected TableOperations tableOps()
Deprecated.will be removed in 1.3.0; avoid using TableOperations for scans or use BaseTable
-
table
public Table table()
-
tableSchema
protected Schema tableSchema()
-
context
protected org.apache.iceberg.TableScanContext context()
-
options
protected java.util.Map<java.lang.String,java.lang.String> options()
-
scanColumns
protected java.util.List<java.lang.String> scanColumns()
-
shouldIgnoreResiduals
protected boolean shouldIgnoreResiduals()
-
shouldPlanWithExecutor
protected boolean shouldPlanWithExecutor()
-
planExecutor
protected java.util.concurrent.ExecutorService planExecutor()
-
newRefinedScan
@Deprecated protected ThisT newRefinedScan(TableOperations ignored, Table newTable, Schema newSchema, org.apache.iceberg.TableScanContext newContext)
Deprecated.will be removed in 1.3.0; use newRefinedScan(Table, Schema, TableScanContext) instead.
-
option
public ThisT option(java.lang.String property, java.lang.String value)
Description copied from interface:Scan
Create a new scan from this scan's configuration that will override theTable
's behavior based on the incoming pair. Unknown properties will be ignored.- Specified by:
option
in interfaceScan<ThisT,T extends ScanTask,G extends ScanTaskGroup<T>>
- Parameters:
property
- name of the table property to be overriddenvalue
- value to override with- Returns:
- a new scan based on this with overridden behavior
-
project
public ThisT project(Schema projectedSchema)
Description copied from interface:Scan
Create a new scan from this with the schema as its projection.- Specified by:
project
in interfaceScan<ThisT,T extends ScanTask,G extends ScanTaskGroup<T>>
- Parameters:
projectedSchema
- a projection schema- Returns:
- a new scan based on this with the given projection
-
caseSensitive
public ThisT caseSensitive(boolean caseSensitive)
Description copied from interface:Scan
Create a new scan from this that, if data columns where selected viaScan.select(java.util.Collection)
, controls whether the match to the schema will be done with case sensitivity. Default is true.- Specified by:
caseSensitive
in interfaceScan<ThisT,T extends ScanTask,G extends ScanTaskGroup<T>>
- Returns:
- a new scan based on this with case sensitivity as stated
-
isCaseSensitive
public boolean isCaseSensitive()
Description copied from interface:Scan
Returns whether this scan is case-sensitive with respect to column names.- Specified by:
isCaseSensitive
in interfaceScan<ThisT,T extends ScanTask,G extends ScanTaskGroup<T>>
- Returns:
- true if case-sensitive, false otherwise.
-
includeColumnStats
public ThisT includeColumnStats()
Description copied from interface:Scan
Create a new scan from this that loads the column stats with each data file.Column stats include: value count, null value count, lower bounds, and upper bounds.
- Specified by:
includeColumnStats
in interfaceScan<ThisT,T extends ScanTask,G extends ScanTaskGroup<T>>
- Returns:
- a new scan based on this that loads column stats.
-
select
public ThisT select(java.util.Collection<java.lang.String> columns)
Description copied from interface:Scan
Create a new scan from this that will read the given data columns. This produces an expected schema that includes all fields that are either selected or used by this scan's filter expression.- Specified by:
select
in interfaceScan<ThisT,T extends ScanTask,G extends ScanTaskGroup<T>>
- Parameters:
columns
- column names from the table's schema- Returns:
- a new scan based on this with the given projection columns
-
filter
public ThisT filter(Expression expr)
Description copied from interface:Scan
Create a new scan from the results of this filtered by theExpression
.- Specified by:
filter
in interfaceScan<ThisT,T extends ScanTask,G extends ScanTaskGroup<T>>
- Parameters:
expr
- a filter expression- Returns:
- a new scan based on this with results filtered by the expression
-
filter
public Expression filter()
Description copied from interface:Scan
Returns this scan's filterExpression
.- Specified by:
filter
in interfaceScan<ThisT,T extends ScanTask,G extends ScanTaskGroup<T>>
- Returns:
- this scan's filter expression
-
ignoreResiduals
public ThisT ignoreResiduals()
Description copied from interface:Scan
Create a new scan from this that applies data filtering to files but not to rows in those files.- Specified by:
ignoreResiduals
in interfaceScan<ThisT,T extends ScanTask,G extends ScanTaskGroup<T>>
- Returns:
- a new scan based on this that does not filter rows in files.
-
planWith
public ThisT planWith(java.util.concurrent.ExecutorService executorService)
Description copied from interface:Scan
Create a new scan to use a particular executor to plan. The default worker pool will be used by default.- Specified by:
planWith
in interfaceScan<ThisT,T extends ScanTask,G extends ScanTaskGroup<T>>
- Parameters:
executorService
- the provided executor- Returns:
- a table scan that uses the provided executor to access manifests
-
schema
public Schema schema()
Description copied from interface:Scan
Returns this scan's projectionSchema
.If the projection schema was set directly using
Scan.project(Schema)
, returns that schema.If the projection schema was set by calling
Scan.select(Collection)
, returns a projection schema that includes the selected data fields and any fields used in the filter expression.- Specified by:
schema
in interfaceScan<ThisT,T extends ScanTask,G extends ScanTaskGroup<T>>
- Returns:
- this scan's projection schema
-
splitLookback
public int splitLookback()
Description copied from interface:Scan
Returns the split lookback for this scan.- Specified by:
splitLookback
in interfaceScan<ThisT,T extends ScanTask,G extends ScanTaskGroup<T>>
-
splitOpenFileCost
public long splitOpenFileCost()
Description copied from interface:Scan
Returns the split open file cost for this scan.- Specified by:
splitOpenFileCost
in interfaceScan<ThisT,T extends ScanTask,G extends ScanTaskGroup<T>>
-
-