Packages

c

org.apache.spark.sql.execution

FileSourceScanExec

case class FileSourceScanExec(relation: HadoopFsRelation, output: Seq[Attribute], requiredSchema: StructType, partitionFilters: Seq[Expression], optionalBucketSet: Option[BitSet], dataFilters: Seq[Expression], tableIdentifier: Option[TableIdentifier]) extends SparkPlan with DataSourceScanExec 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.

optionalBucketSet

Bucket ids for bucket pruning

dataFilters

Filters on non-partition columns.

tableIdentifier

identifier for the table in the metastore.

Linear Supertypes
DataSourceScanExec, LeafExecNode, SparkPlan, Serializable, Serializable, Logging, QueryPlan[SparkPlan], TreeNode[SparkPlan], Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FileSourceScanExec
  2. DataSourceScanExec
  3. LeafExecNode
  4. SparkPlan
  5. Serializable
  6. Serializable
  7. Logging
  8. QueryPlan
  9. TreeNode
  10. Product
  11. Equals
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FileSourceScanExec(relation: HadoopFsRelation, output: Seq[Attribute], requiredSchema: StructType, partitionFilters: Seq[Expression], optionalBucketSet: Option[BitSet], dataFilters: Seq[Expression], tableIdentifier: 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.

    optionalBucketSet

    Bucket ids for bucket pruning

    dataFilters

    Filters on non-partition columns.

    tableIdentifier

    identifier for the table in the metastore.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. lazy val allAttributes: AttributeSeq
    Definition Classes
    QueryPlan
  5. def apply(number: Int): TreeNode[_]
    Definition Classes
    TreeNode
  6. def argString(maxFields: Int): String
    Definition Classes
    TreeNode
  7. def asCode: String
    Definition Classes
    TreeNode
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. lazy val bucketedScan: Boolean
  10. final lazy val canonicalized: SparkPlan
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  11. final def children: Seq[SparkPlan]
    Definition Classes
    LeafExecNode → TreeNode
  12. def cleanupResources(): Unit

    Cleans up the resources used by the physical operator (if any).

    Cleans up the resources used by the physical operator (if any). In general, all the resources should be cleaned up when the task finishes but operators like SortMergeJoinExec and LimitExec may want eager cleanup to free up tight resources (e.g., memory).

    Attributes
    protected[sql]
    Definition Classes
    SparkPlan
  13. def clone(): SparkPlan
    Definition Classes
    TreeNode → AnyRef
  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. def collectWithSubqueries[B](f: PartialFunction[SparkPlan, B]): Seq[B]
    Definition Classes
    QueryPlan
  18. def conf: SQLConf
    Definition Classes
    QueryPlan
  19. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  20. def copyTagsFrom(other: SparkPlan): Unit
    Attributes
    protected
    Definition Classes
    TreeNode
  21. val dataFilters: Seq[Expression]
  22. def doCanonicalize(): FileSourceScanExec
    Definition Classes
    FileSourceScanExec → QueryPlan
  23. def doExecute(): RDD[InternalRow]

    Produces the result of the query as an RDD[InternalRow]

    Produces the result of the query as an RDD[InternalRow]

    Overridden by concrete implementations of SparkPlan.

    Attributes
    protected
    Definition Classes
    FileSourceScanExec → SparkPlan
  24. def doExecuteBroadcast[T](): Broadcast[T]

    Produces the result of the query as a broadcast variable.

    Produces the result of the query as a broadcast variable.

    Overridden by concrete implementations of SparkPlan.

    Attributes
    protected[sql]
    Definition Classes
    SparkPlan
  25. def doExecuteColumnar(): RDD[ColumnarBatch]

    Produces the result of the query as an RDD[ColumnarBatch] if supportsColumnar returns true.

    Produces the result of the query as an RDD[ColumnarBatch] if supportsColumnar returns true. By convention the executor that creates a ColumnarBatch is responsible for closing it when it is no longer needed. This allows input formats to be able to reuse batches if needed.

    Attributes
    protected
    Definition Classes
    FileSourceScanExec → SparkPlan
  26. 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.

    Attributes
    protected
    Definition Classes
    SparkPlan
    Note

    prepare method has already walked down the tree, so the implementation doesn't have to call children's prepare methods. This will only be called once, protected by this.

  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. 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
  29. 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
  30. 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
  31. 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
  32. final def executeColumnar(): RDD[ColumnarBatch]

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

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

    Concrete implementations of SparkPlan should override doColumnarExecute if supportsColumnar returns true.

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

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

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

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

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

    Runs this query returning the last 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 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
  36. 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.

    Definition Classes
    SparkPlan
    Note

    Triggers multiple jobs (one for each partition).

  37. final def expressions: Seq[Expression]
    Definition Classes
    QueryPlan
  38. def fastEquals(other: TreeNode[_]): Boolean
    Definition Classes
    TreeNode
  39. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  40. def find(f: (SparkPlan) ⇒ Boolean): Option[SparkPlan]
    Definition Classes
    TreeNode
  41. def flatMap[A](f: (SparkPlan) ⇒ TraversableOnce[A]): Seq[A]
    Definition Classes
    TreeNode
  42. def foreach(f: (SparkPlan) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  43. def foreachUp(f: (SparkPlan) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  44. def formattedNodeName: String
    Attributes
    protected
    Definition Classes
    QueryPlan
  45. def generateTreeString(depth: Int, lastChildren: Seq[Boolean], append: (String) ⇒ Unit, verbose: Boolean, prefix: String, addSuffix: Boolean, maxFields: Int, printNodeId: Boolean): Unit
    Definition Classes
    TreeNode
  46. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  47. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  48. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  49. val id: Int
    Definition Classes
    SparkPlan
  50. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  51. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  52. def innerChildren: Seq[QueryPlan[_]]
    Definition Classes
    QueryPlan → TreeNode
  53. lazy val inputRDD: RDD[InternalRow]
  54. def inputRDDs(): Seq[RDD[InternalRow]]

    The data being read in.

    The data being read in. This is to provide input to the tests in a way compatible with InputRDDCodegen which all implementations used to extend.

    Definition Classes
    FileSourceScanExec → DataSourceScanExec
  55. def inputSet: AttributeSet
    Definition Classes
    QueryPlan
  56. def isCanonicalizedPlan: Boolean
    Attributes
    protected
    Definition Classes
    QueryPlan
  57. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  58. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  59. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  60. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  61. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  68. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logicalLink: Option[LogicalPlan]

    returns

    The logical plan this plan is linked to.

    Definition Classes
    SparkPlan
  73. def longMetric(name: String): SQLMetric

    returns

    SQLMetric for the name.

    Definition Classes
    SparkPlan
  74. 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
  75. def map[A](f: (SparkPlan) ⇒ A): Seq[A]
    Definition Classes
    TreeNode
  76. def mapChildren(f: (SparkPlan) ⇒ SparkPlan): SparkPlan
    Definition Classes
    TreeNode
  77. def mapExpressions(f: (Expression) ⇒ Expression): FileSourceScanExec.this.type
    Definition Classes
    QueryPlan
  78. def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]
    Attributes
    protected
    Definition Classes
    TreeNode
  79. lazy val metadata: Map[String, String]
    Definition Classes
    FileSourceScanExec → DataSourceScanExec
  80. lazy val metrics: Map[String, SQLMetric]

    returns

    All metrics containing metrics of this SparkPlan.

    Definition Classes
    FileSourceScanExec → SparkPlan
  81. final def missingInput: AttributeSet
    Definition Classes
    QueryPlan
  82. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  83. val nodeName: String
    Definition Classes
    DataSourceScanExec → TreeNode
  84. val nodeNamePrefix: String
    Definition Classes
    FileSourceScanExec → DataSourceScanExec
  85. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  86. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  87. def numberedTreeString: String
    Definition Classes
    TreeNode
  88. val optionalBucketSet: Option[BitSet]
  89. val origin: Origin
    Definition Classes
    TreeNode
  90. def otherCopyArgs: Seq[AnyRef]
    Attributes
    protected
    Definition Classes
    TreeNode
  91. val output: Seq[Attribute]
    Definition Classes
    FileSourceScanExec → QueryPlan
  92. lazy val outputOrdering: Seq[SortOrder]

    Specifies how data is ordered in each partition.

    Specifies how data is ordered in each partition.

    Definition Classes
    FileSourceScanExec → SparkPlan
  93. lazy 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
    FileSourceScanExec → SparkPlan
  94. lazy val outputSet: AttributeSet
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  95. def p(number: Int): SparkPlan
    Definition Classes
    TreeNode
  96. val partitionFilters: Seq[Expression]
  97. final def prepare(): Unit

    Prepares this SparkPlan for execution.

    Prepares this SparkPlan for execution. It's idempotent.

    Definition Classes
    SparkPlan
  98. 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
  99. def prettyJson: String
    Definition Classes
    TreeNode
  100. def printSchema(): Unit
    Definition Classes
    QueryPlan
  101. def producedAttributes: AttributeSet
    Definition Classes
    LeafExecNode → QueryPlan
  102. def redact(text: String): String

    Shorthand for calling redactString() without specifying redacting rules

    Shorthand for calling redactString() without specifying redacting rules

    Attributes
    protected
    Definition Classes
    DataSourceScanExec
  103. lazy val references: AttributeSet
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  104. val relation: HadoopFsRelation
    Definition Classes
    FileSourceScanExec → DataSourceScanExec
  105. def requiredChildDistribution: Seq[Distribution]

    Specifies the data distribution requirements of all the children for this operator.

    Specifies the data distribution requirements of all the children for this operator. By default it's UnspecifiedDistribution for each child, which means each child can have any distribution.

    If an operator overwrites this method, and specifies distribution requirements(excluding UnspecifiedDistribution and BroadcastDistribution) for more than one child, Spark guarantees that the outputs of these children will have same number of partitions, so that the operator can safely zip partitions of these children's result RDDs. Some operators can leverage this guarantee to satisfy some interesting requirement, e.g., non-broadcast joins can specify HashClusteredDistribution(a,b) for its left child, and specify HashClusteredDistribution(c,d) for its right child, then it's guaranteed that left and right child are co-partitioned by a,b/c,d, which means tuples of same value are in the partitions of same index, e.g., (a=1,b=2) and (c=1,d=2) are both in the second partition of left and right child.

    Definition Classes
    SparkPlan
  106. 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
  107. val requiredSchema: StructType
  108. def resetMetrics(): Unit

    Resets all the metrics.

    Resets all the metrics.

    Definition Classes
    SparkPlan
  109. final def sameResult(other: SparkPlan): Boolean
    Definition Classes
    QueryPlan
  110. lazy val schema: StructType
    Definition Classes
    QueryPlan
  111. def schemaString: String
    Definition Classes
    QueryPlan
  112. final def semanticHash(): Int
    Definition Classes
    QueryPlan
  113. def setLogicalLink(logicalPlan: LogicalPlan): Unit

    Set logical plan link recursively if unset.

    Set logical plan link recursively if unset.

    Definition Classes
    SparkPlan
  114. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  115. def simpleString(maxFields: Int): String
    Definition Classes
    DataSourceScanExec → QueryPlan → TreeNode
  116. def simpleStringWithNodeId(): String
    Definition Classes
    QueryPlan → TreeNode
  117. def sparkContext: SparkContext
    Attributes
    protected
    Definition Classes
    SparkPlan
  118. 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
  119. def statePrefix: String
    Attributes
    protected
    Definition Classes
    QueryPlan
  120. def stringArgs: Iterator[Any]
    Attributes
    protected
    Definition Classes
    TreeNode
  121. def subqueries: Seq[SparkPlan]
    Definition Classes
    QueryPlan
  122. def subqueriesAll: Seq[SparkPlan]
    Definition Classes
    QueryPlan
  123. lazy val supportsColumnar: Boolean

    Return true if this stage of the plan supports columnar execution.

    Return true if this stage of the plan supports columnar execution.

    Definition Classes
    FileSourceScanExec → SparkPlan
  124. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  125. val tableIdentifier: Option[TableIdentifier]
    Definition Classes
    FileSourceScanExec → DataSourceScanExec
  126. def toJSON: String
    Definition Classes
    TreeNode
  127. def toString(): String
    Definition Classes
    TreeNode → AnyRef → Any
  128. def transform(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  129. def transformAllExpressions(rule: PartialFunction[Expression, Expression]): FileSourceScanExec.this.type
    Definition Classes
    QueryPlan
  130. def transformDown(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  131. def transformExpressions(rule: PartialFunction[Expression, Expression]): FileSourceScanExec.this.type
    Definition Classes
    QueryPlan
  132. def transformExpressionsDown(rule: PartialFunction[Expression, Expression]): FileSourceScanExec.this.type
    Definition Classes
    QueryPlan
  133. def transformExpressionsUp(rule: PartialFunction[Expression, Expression]): FileSourceScanExec.this.type
    Definition Classes
    QueryPlan
  134. def transformUp(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  135. def treeString(append: (String) ⇒ Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  136. final def treeString(verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): String
    Definition Classes
    TreeNode
  137. final def treeString: String
    Definition Classes
    TreeNode
  138. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  139. def vectorTypes: Option[Seq[String]]

    The exact java types of the columns that are output in columnar processing mode.

    The exact java types of the columns that are output in columnar processing mode. This is a performance optimization for code generation and is optional.

    Definition Classes
    FileSourceScanExec → SparkPlan
  140. def verboseString(maxFields: Int): String
    Definition Classes
    QueryPlan → TreeNode
  141. def verboseStringWithOperatorId(): String
    Definition Classes
    FileSourceScanExec → DataSourceScanExec → LeafExecNode → QueryPlan
  142. def verboseStringWithSuffix(maxFields: Int): String
    Definition Classes
    TreeNode
  143. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  144. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  145. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  146. 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
  147. def withNewChildren(newChildren: Seq[SparkPlan]): SparkPlan
    Definition Classes
    TreeNode

Inherited from DataSourceScanExec

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