Package org.apache.iceberg.spark.source

Class SparkScanBuilder

java.lang.Object
org.apache.iceberg.spark.source.SparkScanBuilder
All Implemented Interfaces:
org.apache.spark.sql.connector.read.Scan, org.apache.spark.sql.connector.read.ScanBuilder, org.apache.spark.sql.connector.read.SupportsPushDownAggregates, org.apache.spark.sql.connector.read.SupportsPushDownRequiredColumns, org.apache.spark.sql.connector.read.SupportsPushDownV2Filters, org.apache.spark.sql.connector.read.SupportsReportStatistics
public class SparkScanBuilder extends Object implements org.apache.spark.sql.connector.read.ScanBuilder, org.apache.spark.sql.connector.read.SupportsPushDownAggregates, org.apache.spark.sql.connector.read.SupportsPushDownV2Filters, org.apache.spark.sql.connector.read.SupportsPushDownRequiredColumns, org.apache.spark.sql.connector.read.SupportsReportStatistics

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.apache.spark.sql.connector.read.Scan

    org.apache.spark.sql.connector.read.Scan.ColumnarSupportMode

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.spark.sql.connector.read.Scan
    build()
     
    org.apache.spark.sql.connector.read.Scan
    buildChangelogScan()
     
    org.apache.spark.sql.connector.read.Scan
    buildCopyOnWriteScan()
     
    org.apache.spark.sql.connector.read.Scan
    buildMergeOnReadScan()
     
    SparkScanBuilder
    caseSensitive(boolean isCaseSensitive)
     
    org.apache.spark.sql.connector.read.Statistics
    estimateStatistics()
     
    void
    pruneColumns(org.apache.spark.sql.types.StructType requestedSchema)
     
    boolean
    pushAggregation(org.apache.spark.sql.connector.expressions.aggregate.Aggregation aggregation)
     
    org.apache.spark.sql.connector.expressions.filter.Predicate[]
    pushedPredicates()
     
    org.apache.spark.sql.connector.expressions.filter.Predicate[]
    pushPredicates(org.apache.spark.sql.connector.expressions.filter.Predicate[] predicates)
     
    org.apache.spark.sql.types.StructType
    readSchema()
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.apache.spark.sql.connector.read.Scan

    columnarSupportMode, description, reportDriverMetrics, supportedCustomMetrics, toBatch, toContinuousStream, toMicroBatchStream

    Methods inherited from interface org.apache.spark.sql.connector.read.SupportsPushDownAggregates

    supportCompletePushDown

  • Method Details

    • caseSensitive

      public SparkScanBuilder caseSensitive(boolean isCaseSensitive)

    • pushPredicates

      public org.apache.spark.sql.connector.expressions.filter.Predicate[] pushPredicates(org.apache.spark.sql.connector.expressions.filter.Predicate[] predicates)
      Specified by:
      pushPredicates in interface org.apache.spark.sql.connector.read.SupportsPushDownV2Filters

    • pushedPredicates

      public org.apache.spark.sql.connector.expressions.filter.Predicate[] pushedPredicates()
      Specified by:
      pushedPredicates in interface org.apache.spark.sql.connector.read.SupportsPushDownV2Filters

    • pushAggregation

      public boolean pushAggregation(org.apache.spark.sql.connector.expressions.aggregate.Aggregation aggregation)
      Specified by:
      pushAggregation in interface org.apache.spark.sql.connector.read.SupportsPushDownAggregates

    • pruneColumns

      public void pruneColumns(org.apache.spark.sql.types.StructType requestedSchema)
      Specified by:
      pruneColumns in interface org.apache.spark.sql.connector.read.SupportsPushDownRequiredColumns

    • build

      public org.apache.spark.sql.connector.read.Scan build()
      Specified by:
      build in interface org.apache.spark.sql.connector.read.ScanBuilder

    • buildChangelogScan

      public org.apache.spark.sql.connector.read.Scan buildChangelogScan()

    • buildMergeOnReadScan

      public org.apache.spark.sql.connector.read.Scan buildMergeOnReadScan()

    • buildCopyOnWriteScan

      public org.apache.spark.sql.connector.read.Scan buildCopyOnWriteScan()

    • estimateStatistics

      public org.apache.spark.sql.connector.read.Statistics estimateStatistics()
      Specified by:
      estimateStatistics in interface org.apache.spark.sql.connector.read.SupportsReportStatistics

    • readSchema

      public org.apache.spark.sql.types.StructType readSchema()
      Specified by:
      readSchema in interface org.apache.spark.sql.connector.read.Scan