Package org.apache.iceberg

Class FilesTable.FilesTableScan

    • 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  
      protected static boolean PLAN_SCANS_WITH_WORKER_POOL  
      protected static java.util.List<java.lang.String> SCAN_COLUMNS  
      protected static java.util.List<java.lang.String> SCAN_WITH_STATS_COLUMNS  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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.
      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 java.util.Set<java.lang.Integer> columnsToKeepStats()  
      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.
      ThisT includeColumnStats​(java.util.Collection<java.lang.String> requestedColumns)
      Create a new scan from this that loads the column stats for the specific columns with each data file.
      protected FileIO io()  
      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
      ThisT metricsReporter​(MetricsReporter reporter)
      Create a new scan that will report scan metrics to the provided reporter in addition to reporters maintained by the scan.
      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 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<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 Expression residualFilter()  
      protected java.util.List<java.lang.String> scanColumns()  
      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()  
      protected boolean shouldReturnColumnStats()  
      int splitLookback()
      Returns the split lookback for this scan.
      long splitOpenFileCost()
      Returns the split open file cost for this scan.
      Table table()  
      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.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • SCAN_COLUMNS

        protected static final java.util.List<java.lang.String> SCAN_COLUMNS

      • SCAN_WITH_STATS_COLUMNS

        protected static final java.util.List<java.lang.String> SCAN_WITH_STATS_COLUMNS

      • DELETE_SCAN_COLUMNS

        protected static final java.util.List<java.lang.String> DELETE_SCAN_COLUMNS

      • DELETE_SCAN_WITH_STATS_COLUMNS

        protected static final java.util.List<java.lang.String> DELETE_SCAN_WITH_STATS_COLUMNS

      • PLAN_SCANS_WITH_WORKER_POOL

        protected static final boolean PLAN_SCANS_WITH_WORKER_POOL

    • 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 files metadata table scan

      • 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

      • 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

      • 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()

      • shouldReturnColumnStats

        protected boolean shouldReturnColumnStats()

      • columnsToKeepStats

        protected java.util.Set<java.lang.Integer> columnsToKeepStats()

      • shouldIgnoreResiduals

        protected boolean shouldIgnoreResiduals()

      • residualFilter

        protected Expression residualFilter()

      • 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.

      • includeColumnStats

        public ThisT includeColumnStats​(java.util.Collection<java.lang.String> requestedColumns)
        Description copied from interface: Scan
        Create a new scan from this that loads the column stats for the specific columns 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>>
        Parameters:
        requestedColumns - column names for which to keep the stats.
        Returns:
        a new scan based on this that loads column stats for specific columns.

      • 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

      • 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>>

      • metricsReporter

        public ThisT metricsReporter​(MetricsReporter reporter)
        Description copied from interface: Scan
        Create a new scan that will report scan metrics to the provided reporter in addition to reporters maintained by the scan.
        Specified by:
        metricsReporter in interface Scan<ThisT,​T extends ScanTask,​G extends ScanTaskGroup<T>>