DataTableScan

java.lang.Object
- org.apache.iceberg.DataTableScan

All Implemented Interfaces:: TableScan

public class DataTableScan
extends java.lang.Object

Constructor Summary

Constructors
Modifier	Constructor and Description
	`DataTableScan(TableOperations ops, Table table)`
`protected`	`DataTableScan(TableOperations ops, Table table, Schema schema, org.apache.iceberg.TableScanContext context)`

Method Summary

All Methods Instance Methods Concrete 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.
`TableScan`	`caseSensitive(boolean scanCaseSensitive)` Create a new `TableScan` from this that, if data columns where selected via `TableScan.select(java.util.Collection)`, controls whether the match to the schema will be done with case sensitivity.
`protected boolean`	`colStats()`
`protected org.apache.iceberg.TableScanContext`	`context()`
`Expression`	`filter()` Returns this scan's filter `Expression`.
`TableScan`	`filter(Expression expr)` Create a new `TableScan` from the results of this filtered by the `Expression`.
`TableScan`	`ignoreResiduals()` Create a new `TableScan` from this that applies data filtering to files but not to rows in those files.
`TableScan`	`includeColumnStats()` Create a new `TableScan` from this that loads the column stats with each data file.
`boolean`	`isCaseSensitive()` Returns whether this scan should apply column name case sensitiveness as per `TableScan.caseSensitive(boolean)`.
`protected TableScan`	`newRefinedScan(TableOperations ops, Table table, Schema schema, org.apache.iceberg.TableScanContext context)`
`TableScan`	`option(java.lang.String property, java.lang.String value)` Create a new `TableScan` 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()`
`CloseableIterable<FileScanTask>`	`planFiles()` Plan the `files` that will be read by this scan.
`CloseableIterable<FileScanTask>`	`planFiles(TableOperations ops, Snapshot snapshot, Expression rowFilter, boolean ignoreResiduals, boolean caseSensitive, boolean colStats)`
`CloseableIterable<CombinedScanTask>`	`planTasks()` Plan the `tasks` for this scan.
`TableScan`	`project(Schema projectedSchema)` Create a new `TableScan` from this with the schema as its projection.
`Schema`	`schema()` Returns this scan's projection `Schema`.
`TableScan`	`select(java.util.Collection<java.lang.String> columns)` Create a new `TableScan` from this that will read the given data columns.
`protected java.util.Collection<java.lang.String>`	`selectedColumns()`
`protected boolean`	`shouldIgnoreResiduals()`
`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()`
`long`	`targetSplitSize()` Returns the target split size for this scan.
`java.lang.String`	`toString()`
`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.TableScan
select

- Constructor Detail
  - DataTableScan
```
public DataTableScan(TableOperations ops,
                     Table table)
```
  - DataTableScan
```
protected DataTableScan(TableOperations ops,
                        Table table,
                        Schema schema,
                        org.apache.iceberg.TableScanContext context)
```
- Method Detail
  - 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
  - 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
  - newRefinedScan
```
protected TableScan newRefinedScan(TableOperations ops,
                                   Table table,
                                   Schema schema,
                                   org.apache.iceberg.TableScanContext context)
```
  - planFiles
```
public CloseableIterable<FileScanTask> planFiles(TableOperations ops,
                                                 Snapshot snapshot,
                                                 Expression rowFilter,
                                                 boolean ignoreResiduals,
                                                 boolean caseSensitive,
                                                 boolean colStats)
```
  - targetSplitSize
```
public long targetSplitSize()
```
    Description copied from interface: TableScan
    
    Returns the target split size for this scan.
  - tableOps
```
protected TableOperations tableOps()
```
  - snapshotId
```
protected java.lang.Long snapshotId()
```
  - colStats
```
protected boolean colStats()
```
  - shouldIgnoreResiduals
```
protected boolean shouldIgnoreResiduals()
```
  - selectedColumns
```
protected java.util.Collection<java.lang.String> selectedColumns()
```
  - options
```
protected java.util.Map<java.lang.String,java.lang.String> options()
```
  - context
```
protected org.apache.iceberg.TableScanContext context()
```
  - 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
  - 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.
    
    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
  - option
```
public TableScan option(java.lang.String property,
                        java.lang.String value)
```
    Description copied from interface: TableScan
    
    Create a new TableScan 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 TableScan
    
    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 TableScan project(Schema projectedSchema)
```
    Description copied from interface: TableScan
    
    Create a new TableScan from this with the schema as its projection.
    
    Specified by:
    
    project in interface TableScan
    
    Parameters:
    
    projectedSchema - a projection schema
    
    Returns:
    
    a new scan based on this with the given projection
  - caseSensitive
```
public TableScan caseSensitive(boolean scanCaseSensitive)
```
    Description copied from interface: TableScan
    
    Create a new TableScan from this that, if data columns where selected via TableScan.select(java.util.Collection), controls whether the match to the schema will be done with case sensitivity.
    
    Specified by:
    
    caseSensitive in interface TableScan
    
    Returns:
    
    a new scan based on this with case sensitivity as stated
  - includeColumnStats
```
public TableScan includeColumnStats()
```
    Description copied from interface: TableScan
    
    Create a new TableScan 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 TableScan
    
    Returns:
    
    a new scan based on this that loads column stats.
  - select
```
public TableScan select(java.util.Collection<java.lang.String> columns)
```
    Description copied from interface: TableScan
    
    Create a new TableScan 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 TableScan
    
    Parameters:
    
    columns - column names from the table's schema
    
    Returns:
    
    a new scan based on this with the given projection columns
  - filter
```
public TableScan filter(Expression expr)
```
    Description copied from interface: TableScan
    
    Create a new TableScan from the results of this filtered by the Expression.
    
    Specified by:
    
    filter in interface TableScan
    
    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: TableScan
    
    Returns this scan's filter Expression.
    
    Specified by:
    
    filter in interface TableScan
    
    Returns:
    
    this scan's filter expression
  - ignoreResiduals
```
public TableScan ignoreResiduals()
```
    Description copied from interface: TableScan
    
    Create a new TableScan from this that applies data filtering to files but not to rows in those files.
    
    Specified by:
    
    ignoreResiduals in interface TableScan
    
    Returns:
    
    a new scan based on this that does not filter rows in files.
  - planFiles
```
public CloseableIterable<FileScanTask> planFiles()
```
    Description copied from interface: TableScan
    
    Plan the files that will be read by this scan.
    Each file has a residual expression that should be applied to filter the file's rows.
    This simple plan returns file scans for each file from position 0 to the file's length. For planning that will combine small files, split large files, and attempt to balance work, use TableScan.planTasks() instead.
    
    Specified by:
    
    planFiles in interface TableScan
    
    Returns:
    
    an Iterable of file tasks that are required by this scan
  - planTasks
```
public CloseableIterable<CombinedScanTask> planTasks()
```
    Description copied from interface: TableScan
    
    Plan the tasks for this scan.
    Tasks created by this method may read partial input files, multiple input files, or both.
    
    Specified by:
    
    planTasks in interface TableScan
    
    Returns:
    
    an Iterable of tasks for this scan
  - splitLookback
```
public int splitLookback()
```
    Description copied from interface: TableScan
    
    Returns the split lookback for this scan.
    
    Specified by:
    
    splitLookback in interface TableScan
  - splitOpenFileCost
```
public long splitOpenFileCost()
```
    Description copied from interface: TableScan
    
    Returns the split open file cost for this scan.
    
    Specified by:
    
    splitOpenFileCost in interface TableScan
  - schema
```
public Schema schema()
```
    Description copied from interface: TableScan
    
    Returns this scan's projection Schema.
    If the projection schema was set directly using TableScan.project(Schema), returns that schema.
    If the projection schema was set by calling TableScan.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 TableScan
    
    Returns:
    
    this scan's projection schema
  - 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
  - isCaseSensitive
```
public boolean isCaseSensitive()
```
    Description copied from interface: TableScan
    
    Returns whether this scan should apply column name case sensitiveness as per TableScan.caseSensitive(boolean).
    
    Specified by:
    
    isCaseSensitive in interface TableScan
    
    Returns:
    
    true if case sensitive, false otherwise.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class DataTableScan

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.iceberg.TableScan

Constructor Detail

DataTableScan

DataTableScan

Method Detail

appendsBetween

appendsAfter

useSnapshot

newRefinedScan

planFiles

targetSplitSize

tableOps

snapshotId

colStats

shouldIgnoreResiduals

selectedColumns

options

context

table

asOfTime

option

project

caseSensitive

includeColumnStats

select

filter

filter

ignoreResiduals

planFiles

planTasks

splitLookback

splitOpenFileCost

schema

snapshot

isCaseSensitive

toString