FilesTable.FilesTableScan

java.lang.Object
- org.apache.iceberg.FilesTable.FilesTableScan

All Implemented Interfaces:

Scan<TableScan,FileScanTask,CombinedScanTask>, TableScan

Enclosing class:

FilesTable
```
public static class FilesTable.FilesTableScan
extends java.lang.Object
```

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`TableScan`	`appendsAfter(long fromSnapshotId)` Create a new `TableScan` to read appended data from `fromSnapshotId` exclusive to the current snapshot inclusive.
`TableScan`	`appendsBetween(long fromSnapshotId, long toSnapshotId)` Create a new `TableScan` to read appended data from `fromSnapshotId` exclusive to `toSnapshotId` inclusive.
`TableScan`	`asOfTime(long timestampMillis)` Create a new `TableScan` 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 via `Scan.select(java.util.Collection)`, controls whether the match to the schema will be done with case sensitivity.
`protected boolean`	`colStats()` Deprecated. Will be removed in 1.2.0, use `TableScanContext.returnColumnStats()` directly.
`protected org.apache.iceberg.TableScanContext`	`context()`
`protected CloseableIterable<FileScanTask>`	`doPlanFiles()`
`Expression`	`filter()` Returns this scan's filter `Expression`.
`ThisT`	`filter(Expression expr)` Create a new scan from the results of this filtered by the `Expression`.
`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 files metadata table scan
`protected TableScan`	`newRefinedScan(TableOperations ops, 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 the `Table`'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 java.util.List<java.lang.String>`	`scanColumns()`
`protected ScanMetrics`	`scanMetrics()`
`Schema`	`schema()` Returns this scan's projection `Schema`.
`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()`
`Snapshot`	`snapshot()` Returns the `Snapshot` that will be used by this scan.
`protected java.lang.Long`	`snapshotId()`
`int`	`splitLookback()` Returns the split lookback for this scan.
`long`	`splitOpenFileCost()` Returns the split open file cost for this scan.
`Table`	`table()` Returns the `Table` from which this scan loads data.
`protected TableOperations`	`tableOps()`
`protected Schema`	`tableSchema()`
`protected MetadataTableType`	`tableType()` Type of scan being performed, such as `MetadataTableType.ALL_DATA_FILES` when scanning a table's `AllDataFilesTable`.
`long`	`targetSplitSize()` Returns the target split size for this scan.
`java.lang.String`	`toString()`
`TableScan`	`useRef(java.lang.String name)` Create a new `TableScan` from this scan's configuration that will use the given reference.
`TableScan`	`useSnapshot(long scanSnapshotId)` Create a new `TableScan` from this scan's configuration that will use the given snapshot by ID.

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(TableOperations ops,
                                   Table table,
                                   Schema schema,
                                   org.apache.iceberg.TableScanContext context)
```
  - manifests
```
protected CloseableIterable<ManifestFile> manifests()
```
    Returns an iterable of manifest files to explore for this files metadata table scan
  - doPlanFiles
```
protected CloseableIterable<FileScanTask> doPlanFiles()
```
  - tableType
```
protected MetadataTableType tableType()
```
    Type of scan being performed, such as MetadataTableType.ALL_DATA_FILES when scanning a table's AllDataFilesTable.
    Used for logging and error messages.
  - appendsBetween
```
public TableScan appendsBetween(long fromSnapshotId,
                                long toSnapshotId)
```
    Description copied from interface: TableScan
    
    Create a new TableScan to read appended data from fromSnapshotId exclusive to toSnapshotId inclusive.
    
    Specified by:
    
    appendsBetween in interface TableScan
    
    Parameters:
    
    fromSnapshotId - the last snapshot id read by the user, exclusive
    
    toSnapshotId - read append data up to this snapshot id
    
    Returns:
    
    a table scan which can read append data from fromSnapshotId exclusive and up to toSnapshotId inclusive
  - appendsAfter
```
public TableScan appendsAfter(long fromSnapshotId)
```
    Description copied from interface: TableScan
    
    Create a new TableScan to read appended data from fromSnapshotId exclusive to the current snapshot inclusive.
    
    Specified by:
    
    appendsAfter in interface TableScan
    
    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 interface Scan<TableScan,FileScanTask,CombinedScanTask>
  - snapshotId
```
protected java.lang.Long snapshotId()
```
  - colStats
```
@Deprecated
protected boolean colStats()
```
    Deprecated. Will be removed in 1.2.0, use TableScanContext.returnColumnStats() directly.
    
    Returns:
    
    whether column stats are returned.
  - options
```
protected java.util.Map<java.lang.String,java.lang.String> options()
```
  - scanMetrics
```
protected ScanMetrics scanMetrics()
```
  - table
```
public Table table()
```
    Description copied from interface: TableScan
    
    Returns the Table from which this scan loads data.
    
    Specified by:
    
    table in interface TableScan
    
    Returns:
    
    this scan's table
  - useSnapshot
```
public TableScan useSnapshot(long scanSnapshotId)
```
    Description copied from interface: TableScan
    
    Create a new TableScan from this scan's configuration that will use the given snapshot by ID.
    
    Specified by:
    
    useSnapshot in interface TableScan
    
    Parameters:
    
    scanSnapshotId - a snapshot ID
    
    Returns:
    
    a new scan based on this with the given snapshot ID
  - useRef
```
public TableScan useRef(java.lang.String name)
```
    Description copied from interface: TableScan
    
    Create a new TableScan from this scan's configuration that will use the given reference.
    
    Specified by:
    
    useRef in interface TableScan
    
    Parameters:
    
    name - reference
    
    Returns:
    
    a new scan based on the given reference.
  - asOfTime
```
public TableScan asOfTime(long timestampMillis)
```
    Description copied from interface: TableScan
    
    Create a new TableScan 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 interface TableScan
    
    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 interface Scan<TableScan,FileScanTask,CombinedScanTask>
    
    Returns:
    
    an Iterable of tasks scanning entire files required by this scan
  - 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 interface Scan<TableScan,FileScanTask,CombinedScanTask>
    
    Returns:
    
    an Iterable of balanced task groups required by this scan
  - snapshot
```
public Snapshot snapshot()
```
    Description copied from interface: TableScan
    
    Returns the Snapshot that will be used by this scan.
    If the snapshot was not configured using TableScan.asOfTime(long) or TableScan.useSnapshot(long), the current table snapshot will be used.
    
    Specified by:
    
    snapshot in interface TableScan
    
    Returns:
    
    the Snapshot this scan will use
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - tableOps
```
protected TableOperations tableOps()
```
  - tableSchema
```
protected Schema tableSchema()
```
  - context
```
protected org.apache.iceberg.TableScanContext context()
```
  - scanColumns
```
protected java.util.List<java.lang.String> scanColumns()
```
  - shouldIgnoreResiduals
```
protected boolean shouldIgnoreResiduals()
```
  - shouldPlanWithExecutor
```
protected boolean shouldPlanWithExecutor()
```
  - planExecutor
```
protected java.util.concurrent.ExecutorService planExecutor()
```
  - 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 the Table's behavior based on the incoming pair. Unknown properties will be ignored.
    
    Specified by:
    
    option in interface Scan<ThisT,T extends ScanTask,G extends ScanTaskGroup<T>>
    
    Parameters:
    
    property - name of the table property to be overridden
    
    value - 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 interface Scan<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 via Scan.select(java.util.Collection), controls whether the match to the schema will be done with case sensitivity. Default is true.
    
    Specified by:
    
    caseSensitive in interface Scan<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 interface Scan<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 interface Scan<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 interface Scan<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 the Expression.
    
    Specified by:
    
    filter in interface Scan<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 filter Expression.
    
    Specified by:
    
    filter in interface Scan<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 interface Scan<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 interface Scan<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 projection Schema.
    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 interface Scan<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 interface Scan<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 interface Scan<ThisT,T extends ScanTask,G extends ScanTaskGroup<T>>

Class FilesTable.FilesTableScan

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.iceberg.Scan

Method Detail

newRefinedScan

manifests

doPlanFiles

tableType

appendsBetween

appendsAfter

targetSplitSize

snapshotId

colStats

options

scanMetrics

table

useSnapshot

useRef

asOfTime

planFiles

planTasks

snapshot

toString

tableOps

tableSchema

context

scanColumns

shouldIgnoreResiduals

shouldPlanWithExecutor

planExecutor

option

project

caseSensitive

isCaseSensitive

includeColumnStats

select

filter

filter

ignoreResiduals

planWith

schema

splitLookback

splitOpenFileCost