org.apache.spark.sql.execution

FileSourceScanExec

case class FileSourceScanExec(relation: HadoopFsRelation, output: Seq[Attribute], requiredSchema: StructType, partitionFilters: Seq[Expression], dataFilters: Seq[Expression], metastoreTableIdentifier: Option[TableIdentifier]) extends SparkPlan with DataSourceScanExec with ColumnarBatchScan with Product with Serializable

Physical plan node for scanning data from HadoopFsRelations.

relation

The file-based relation to scan.

output

Output attributes of the scan, including data attributes and partition attributes.

requiredSchema

Required schema of the underlying relation, excluding partition columns.

partitionFilters

Predicates to use for partition pruning.

dataFilters

Filters on non-partition columns.

metastoreTableIdentifier

identifier for the table in the metastore.

Linear Supertypes
ColumnarBatchScan, DataSourceScanExec, CodegenSupport, LeafExecNode, SparkPlan, Serializable, Serializable, Logging, QueryPlan[SparkPlan], TreeNode[SparkPlan], Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FileSourceScanExec
  2. ColumnarBatchScan
  3. DataSourceScanExec
  4. CodegenSupport
  5. LeafExecNode
  6. SparkPlan
  7. Serializable
  8. Serializable
  9. Logging
  10. QueryPlan
  11. TreeNode
  12. Product
  13. Equals
  14. AnyRef
  15. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FileSourceScanExec(relation: HadoopFsRelation, output: Seq[Attribute], requiredSchema: StructType, partitionFilters: Seq[Expression], dataFilters: Seq[Expression], metastoreTableIdentifier: Option[TableIdentifier])

    relation

    The file-based relation to scan.

    output

    Output attributes of the scan, including data attributes and partition attributes.

    requiredSchema

    Required schema of the underlying relation, excluding partition columns.

    partitionFilters

    Predicates to use for partition pruning.

    dataFilters

    Filters on non-partition columns.

    metastoreTableIdentifier

    identifier for the table in the metastore.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. lazy val allAttributes: AttributeSeq

    Definition Classes
    QueryPlan
  7. def apply(number: Int): TreeNode[_]

    Definition Classes
    TreeNode
  8. def argString: String

    Definition Classes
    TreeNode
  9. def asCode: String

    Definition Classes
    TreeNode
  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. lazy val canonicalized: FileSourceScanExec

    Definition Classes
    FileSourceScanExec → QueryPlan
  12. final def children: Seq[SparkPlan]

    Definition Classes
    LeafExecNode → TreeNode
  13. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def collect[B](pf: PartialFunction[SparkPlan, B]): Seq[B]

    Definition Classes
    TreeNode
  15. def collectFirst[B](pf: PartialFunction[SparkPlan, B]): Option[B]

    Definition Classes
    TreeNode
  16. def collectLeaves(): Seq[SparkPlan]

    Definition Classes
    TreeNode
  17. lazy val constraints: ExpressionSet

    Definition Classes
    QueryPlan
  18. final def consume(ctx: CodegenContext, outputVars: Seq[ExprCode], row: String = null): String

    Consume the generated columns or row from current SparkPlan, call its parent's doConsume().

    Consume the generated columns or row from current SparkPlan, call its parent's doConsume().

    Definition Classes
    CodegenSupport
  19. lazy val containsChild: Set[TreeNode[_]]

    Definition Classes
    TreeNode
  20. val dataFilters: Seq[Expression]

    Filters on non-partition columns.

  21. def doConsume(ctx: CodegenContext, input: Seq[ExprCode], row: ExprCode): String

    Generate the Java source code to process the rows from child SparkPlan.

    Generate the Java source code to process the rows from child SparkPlan.

    This should be override by subclass to support codegen.

    For example, Filter will generate the code like this:

    # code to evaluate the predicate expression, result is isNull1 and value2 if (isNull1 || !value2) continue; # call consume(), which will call parent.doConsume()

    Note: A plan can either consume the rows as UnsafeRow (row), or a list of variables (input).

    Definition Classes
    CodegenSupport
  22. def doExecute(): RDD[InternalRow]

    Overridden by concrete implementations of SparkPlan.

    Overridden by concrete implementations of SparkPlan. Produces the result of the query as an RDD[InternalRow]

    Attributes
    protected
    Definition Classes
    FileSourceScanExecSparkPlan
  23. def doExecuteBroadcast[T](): Broadcast[T]

    Overridden by concrete implementations of SparkPlan.

    Overridden by concrete implementations of SparkPlan. Produces the result of the query as a broadcast variable.

    Attributes
    protected[org.apache.spark.sql]
    Definition Classes
    SparkPlan
  24. def doPrepare(): Unit

    Overridden by concrete implementations of SparkPlan.

    Overridden by concrete implementations of SparkPlan. It is guaranteed to run before any execute of SparkPlan. This is helpful if we want to set up some state before executing the query, e.g., BroadcastHashJoin uses it to broadcast asynchronously.

    Note: the prepare method has already walked down the tree, so the implementation doesn't need to call children's prepare methods.

    This will only be called once, protected by this.

    Attributes
    protected
    Definition Classes
    SparkPlan
  25. def doProduce(ctx: CodegenContext): String

    Produce code to process the input iterator as ColumnarBatches.

    Produce code to process the input iterator as ColumnarBatches. This produces an UnsafeRow for each row in each batch.

    Attributes
    protected
    Definition Classes
    FileSourceScanExec → ColumnarBatchScan → CodegenSupport
  26. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  27. def evaluateRequiredVariables(attributes: Seq[Attribute], variables: Seq[ExprCode], required: AttributeSet): String

    Returns source code to evaluate the variables for required attributes, and clear the code of evaluated variables, to prevent them to be evaluated twice.

    Returns source code to evaluate the variables for required attributes, and clear the code of evaluated variables, to prevent them to be evaluated twice.

    Attributes
    protected
    Definition Classes
    CodegenSupport
  28. def evaluateVariables(variables: Seq[ExprCode]): String

    Returns source code to evaluate all the variables, and clear the code of them, to prevent them to be evaluated twice.

    Returns source code to evaluate all the variables, and clear the code of them, to prevent them to be evaluated twice.

    Attributes
    protected
    Definition Classes
    CodegenSupport
  29. final def execute(): RDD[InternalRow]

    Returns the result of this query as an RDD[InternalRow] by delegating to doExecute after preparations.

    Returns the result of this query as an RDD[InternalRow] by delegating to doExecute after preparations.

    Concrete implementations of SparkPlan should override doExecute.

    Definition Classes
    SparkPlan
  30. final def executeBroadcast[T](): Broadcast[T]

    Returns the result of this query as a broadcast variable by delegating to doExecuteBroadcast after preparations.

    Returns the result of this query as a broadcast variable by delegating to doExecuteBroadcast after preparations.

    Concrete implementations of SparkPlan should override doExecuteBroadcast.

    Definition Classes
    SparkPlan
  31. def executeCollect(): Array[InternalRow]

    Runs this query returning the result as an array.

    Runs this query returning the result as an array.

    Definition Classes
    SparkPlan
  32. def executeCollectPublic(): Array[Row]

    Runs this query returning the result as an array, using external Row format.

    Runs this query returning the result as an array, using external Row format.

    Definition Classes
    SparkPlan
  33. final def executeQuery[T](query: ⇒ T): T

    Execute a query after preparing the query and adding query plan information to created RDDs for visualization.

    Execute a query after preparing the query and adding query plan information to created RDDs for visualization.

    Attributes
    protected
    Definition Classes
    SparkPlan
  34. def executeTake(n: Int): Array[InternalRow]

    Runs this query returning the first n rows as an array.

    Runs this query returning the first n rows as an array.

    This is modeled after RDD.take but never runs any job locally on the driver.

    Definition Classes
    SparkPlan
  35. def executeToIterator(): Iterator[InternalRow]

    Runs this query returning the result as an iterator of InternalRow.

    Runs this query returning the result as an iterator of InternalRow.

    Note: this will trigger multiple jobs (one for each partition).

    Definition Classes
    SparkPlan
  36. final def expressions: Seq[Expression]

    Definition Classes
    QueryPlan
  37. def fastEquals(other: TreeNode[_]): Boolean

    Definition Classes
    TreeNode
  38. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  39. def find(f: (SparkPlan) ⇒ Boolean): Option[SparkPlan]

    Definition Classes
    TreeNode
  40. def flatMap[A](f: (SparkPlan) ⇒ TraversableOnce[A]): Seq[A]

    Definition Classes
    TreeNode
  41. def foreach(f: (SparkPlan) ⇒ Unit): Unit

    Definition Classes
    TreeNode
  42. def foreachUp(f: (SparkPlan) ⇒ Unit): Unit

    Definition Classes
    TreeNode
  43. def generateTreeString(depth: Int, lastChildren: Seq[Boolean], builder: StringBuilder, verbose: Boolean, prefix: String, addSuffix: Boolean): StringBuilder

    Definition Classes
    TreeNode
  44. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  45. def getRelevantConstraints(constraints: Set[Expression]): Set[Expression]

    Attributes
    protected
    Definition Classes
    QueryPlan
  46. def hashCode(): Int

    Definition Classes
    TreeNode → AnyRef → Any
  47. val inMemoryTableScan: InMemoryTableScanExec

    Definition Classes
    ColumnarBatchScan
  48. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Attributes
    protected
    Definition Classes
    Logging
  49. def innerChildren: Seq[QueryPlan[_]]

    Attributes
    protected
    Definition Classes
    QueryPlan → TreeNode
  50. def inputRDDs(): Seq[RDD[InternalRow]]

    Returns all the RDDs of InternalRow which generates the input rows.

    Returns all the RDDs of InternalRow which generates the input rows.

    Note: right now we support up to two RDDs.

    Definition Classes
    FileSourceScanExecCodegenSupport
  51. def inputSet: AttributeSet

    Definition Classes
    QueryPlan
  52. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  53. def isShouldStopRequired: Boolean

    For optimization to suppress shouldStop() in a loop of WholeStageCodegen.

    For optimization to suppress shouldStop() in a loop of WholeStageCodegen. Returning true means we need to insert shouldStop() into the loop producing rows, if any.

    Definition Classes
    CodegenSupport
  54. def isTraceEnabled(): Boolean

    Attributes
    protected
    Definition Classes
    Logging
  55. def jsonFields: List[(String, JValue)]

    Attributes
    protected
    Definition Classes
    TreeNode
  56. def log: Logger

    Attributes
    protected
    Definition Classes
    Logging
  57. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  58. def logDebug(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  59. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  60. def logError(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  61. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  62. def logInfo(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  63. def logName: String

    Attributes
    protected
    Definition Classes
    Logging
  64. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  65. def logTrace(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  66. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  67. def logWarning(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  68. def longMetric(name: String): SQLMetric

    Return a LongSQLMetric according to the name.

    Return a LongSQLMetric according to the name.

    Definition Classes
    SparkPlan
  69. def makeCopy(newArgs: Array[AnyRef]): SparkPlan

    Overridden make copy also propagates sqlContext to copied plan.

    Overridden make copy also propagates sqlContext to copied plan.

    Definition Classes
    SparkPlan → TreeNode
  70. def map[A](f: (SparkPlan) ⇒ A): Seq[A]

    Definition Classes
    TreeNode
  71. def mapChildren(f: (SparkPlan) ⇒ SparkPlan): SparkPlan

    Definition Classes
    TreeNode
  72. def mapExpressions(f: (Expression) ⇒ Expression): FileSourceScanExec.this.type

    Definition Classes
    QueryPlan
  73. def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]

    Attributes
    protected
    Definition Classes
    TreeNode
  74. val metadata: Map[String, String]

    Return all metadata that describes more details of this SparkPlan.

    Return all metadata that describes more details of this SparkPlan.

    Definition Classes
    FileSourceScanExecSparkPlan
  75. val metastoreTableIdentifier: Option[TableIdentifier]

    identifier for the table in the metastore.

    identifier for the table in the metastore.

    Definition Classes
    FileSourceScanExecDataSourceScanExec
  76. def metricTerm(ctx: CodegenContext, name: String): String

    Creates a metric using the specified name.

    Creates a metric using the specified name.

    returns

    name of the variable representing the metric

    Definition Classes
    CodegenSupport
  77. lazy val metrics: Map[String, SQLMetric]

    Definition Classes
    FileSourceScanExec → ColumnarBatchScan → SparkPlan
  78. def missingInput: AttributeSet

    Definition Classes
    QueryPlan
  79. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  80. val needsUnsafeRowConversion: Boolean

  81. def newMutableProjection(expressions: Seq[Expression], inputSchema: Seq[Attribute], useSubexprElimination: Boolean = false): MutableProjection

    Attributes
    protected
    Definition Classes
    SparkPlan
  82. def newNaturalAscendingOrdering(dataTypes: Seq[DataType]): Ordering[InternalRow]

    Creates a row ordering for the given schema, in natural ascending order.

    Creates a row ordering for the given schema, in natural ascending order.

    Attributes
    protected
    Definition Classes
    SparkPlan
  83. def newOrdering(order: Seq[SortOrder], inputSchema: Seq[Attribute]): Ordering[InternalRow]

    Attributes
    protected
    Definition Classes
    SparkPlan
  84. def newPredicate(expression: Expression, inputSchema: Seq[Attribute]): Predicate

    Attributes
    protected
    Definition Classes
    SparkPlan
  85. val nodeName: String

    Definition Classes
    DataSourceScanExec → TreeNode
  86. val nodeNamePrefix: String

    Definition Classes
    FileSourceScanExecDataSourceScanExec
  87. final def notify(): Unit

    Definition Classes
    AnyRef
  88. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  89. def numberedTreeString: String

    Definition Classes
    TreeNode
  90. val origin: Origin

    Definition Classes
    TreeNode
  91. def otherCopyArgs: Seq[AnyRef]

    Attributes
    protected
    Definition Classes
    TreeNode
  92. val output: Seq[Attribute]

    Output attributes of the scan, including data attributes and partition attributes.

    Output attributes of the scan, including data attributes and partition attributes.

    Definition Classes
    FileSourceScanExec → QueryPlan
  93. val outputOrdering: Seq[SortOrder]

    Specifies how data is ordered in each partition.

    Specifies how data is ordered in each partition.

    Definition Classes
    FileSourceScanExecSparkPlan
  94. val outputPartitioning: Partitioning

    Specifies how data is partitioned across different nodes in the cluster.

    Specifies how data is partitioned across different nodes in the cluster.

    Definition Classes
    FileSourceScanExecSparkPlan
  95. def outputSet: AttributeSet

    Definition Classes
    QueryPlan
  96. def p(number: Int): SparkPlan

    Definition Classes
    TreeNode
  97. var parent: CodegenSupport

    Which SparkPlan is calling produce() of this one.

    Which SparkPlan is calling produce() of this one. It's itself for the first SparkPlan.

    Attributes
    protected
    Definition Classes
    CodegenSupport
  98. val partitionFilters: Seq[Expression]

    Predicates to use for partition pruning.

  99. def preCanonicalized: SparkPlan

    Attributes
    protected
    Definition Classes
    QueryPlan
  100. final def prepare(): Unit

    Prepare a SparkPlan for execution.

    Prepare a SparkPlan for execution. It's idempotent.

    Definition Classes
    SparkPlan
  101. def prepareSubqueries(): Unit

    Finds scalar subquery expressions in this plan node and starts evaluating them.

    Finds scalar subquery expressions in this plan node and starts evaluating them.

    Attributes
    protected
    Definition Classes
    SparkPlan
  102. def prettyJson: String

    Definition Classes
    TreeNode
  103. def printSchema(): Unit

    Definition Classes
    QueryPlan
  104. final def produce(ctx: CodegenContext, parent: CodegenSupport): String

    Returns Java source code to process the rows from input RDD.

    Returns Java source code to process the rows from input RDD.

    Definition Classes
    CodegenSupport
  105. def producedAttributes: AttributeSet

    Definition Classes
    LeafExecNode → QueryPlan
  106. def references: AttributeSet

    Definition Classes
    QueryPlan
  107. val relation: HadoopFsRelation

    The file-based relation to scan.

    The file-based relation to scan.

    Definition Classes
    FileSourceScanExecDataSourceScanExec
  108. def requiredChildDistribution: Seq[Distribution]

    Specifies any partition requirements on the input data for this operator.

    Specifies any partition requirements on the input data for this operator.

    Definition Classes
    SparkPlan
  109. def requiredChildOrdering: Seq[Seq[SortOrder]]

    Specifies sort order for each partition requirements on the input data for this operator.

    Specifies sort order for each partition requirements on the input data for this operator.

    Definition Classes
    SparkPlan
  110. val requiredSchema: StructType

    Required schema of the underlying relation, excluding partition columns.

  111. def resetMetrics(): Unit

    Reset all the metrics.

    Reset all the metrics.

    Definition Classes
    SparkPlan
  112. final def sameResult(other: SparkPlan): Boolean

    Definition Classes
    QueryPlan
  113. lazy val schema: StructType

    Definition Classes
    QueryPlan
  114. def schemaString: String

    Definition Classes
    QueryPlan
  115. final def semanticHash(): Int

    Definition Classes
    QueryPlan
  116. def shouldStopRequired: Boolean

    Set to false if this plan consumes all rows produced by children but doesn't output row to buffer by calling append(), so the children don't require shouldStop() in the loop of producing rows.

    Set to false if this plan consumes all rows produced by children but doesn't output row to buffer by calling append(), so the children don't require shouldStop() in the loop of producing rows.

    Attributes
    protected
    Definition Classes
    CodegenSupport
  117. def simpleString: String

    Definition Classes
    DataSourceScanExec → QueryPlan → TreeNode
  118. def sparkContext: SparkContext

    Attributes
    protected
    Definition Classes
    SparkPlan
  119. final val sqlContext: SQLContext

    A handle to the SQL Context that was used to create this plan.

    A handle to the SQL Context that was used to create this plan. Since many operators need access to the sqlContext for RDD operations or configuration this field is automatically populated by the query planning infrastructure.

    Definition Classes
    SparkPlan
  120. def statePrefix: String

    Attributes
    protected
    Definition Classes
    QueryPlan
  121. def stringArgs: Iterator[Any]

    Attributes
    protected
    Definition Classes
    TreeNode
  122. val subexpressionEliminationEnabled: Boolean

    Definition Classes
    SparkPlan
  123. def subqueries: Seq[SparkPlan]

    Definition Classes
    QueryPlan
  124. def supportCodegen: Boolean

    Whether this SparkPlan support whole stage codegen or not.

    Whether this SparkPlan support whole stage codegen or not.

    Definition Classes
    CodegenSupport
  125. val supportsBatch: Boolean

  126. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  127. def toJSON: String

    Definition Classes
    TreeNode
  128. def toString(): String

    Definition Classes
    TreeNode → AnyRef → Any
  129. def transform(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan

    Definition Classes
    TreeNode
  130. def transformAllExpressions(rule: PartialFunction[Expression, Expression]): FileSourceScanExec.this.type

    Definition Classes
    QueryPlan
  131. def transformDown(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan

    Definition Classes
    TreeNode
  132. def transformExpressions(rule: PartialFunction[Expression, Expression]): FileSourceScanExec.this.type

    Definition Classes
    QueryPlan
  133. def transformExpressionsDown(rule: PartialFunction[Expression, Expression]): FileSourceScanExec.this.type

    Definition Classes
    QueryPlan
  134. def transformExpressionsUp(rule: PartialFunction[Expression, Expression]): FileSourceScanExec.this.type

    Definition Classes
    QueryPlan
  135. def transformUp(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan

    Definition Classes
    TreeNode
  136. def treeString(verbose: Boolean, addSuffix: Boolean): String

    Definition Classes
    DataSourceScanExec → TreeNode
  137. def treeString: String

    Definition Classes
    TreeNode
  138. def usedInputs: AttributeSet

    The subset of inputSet those should be evaluated before this plan.

    The subset of inputSet those should be evaluated before this plan.

    We will use this to insert some code to access those columns that are actually used by current plan before calling doConsume().

    Definition Classes
    CodegenSupport
  139. def validConstraints: Set[Expression]

    Attributes
    protected
    Definition Classes
    QueryPlan
  140. def verboseString: String

    Definition Classes
    DataSourceScanExec → QueryPlan → TreeNode
  141. def verboseStringWithSuffix: String

    Definition Classes
    TreeNode
  142. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  143. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  144. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  145. def waitForSubqueries(): Unit

    Blocks the thread until all subqueries finish evaluation and update the results.

    Blocks the thread until all subqueries finish evaluation and update the results.

    Attributes
    protected
    Definition Classes
    SparkPlan
  146. def withNewChildren(newChildren: Seq[SparkPlan]): SparkPlan

    Definition Classes
    TreeNode

Inherited from ColumnarBatchScan

Inherited from DataSourceScanExec

Inherited from CodegenSupport

Inherited from LeafExecNode

Inherited from SparkPlan

Inherited from Serializable

Inherited from Serializable

Inherited from Logging

Inherited from QueryPlan[SparkPlan]

Inherited from TreeNode[SparkPlan]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped