Packages

t

org.apache.spark.sql.execution

FileSourceScanLike

trait FileSourceScanLike extends SparkPlan with DataSourceScanExec

A base trait for file scans containing file listing and metrics code.

Linear Supertypes
DataSourceScanExec, LeafExecNode, LeafLike[SparkPlan], SparkPlan, Serializable, Logging, QueryPlan[SparkPlan], SQLConfHelper, TreeNode[SparkPlan], WithOrigin, TreePatternBits, Product, Equals, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FileSourceScanLike
  2. DataSourceScanExec
  3. LeafExecNode
  4. LeafLike
  5. SparkPlan
  6. Serializable
  7. Logging
  8. QueryPlan
  9. SQLConfHelper
  10. TreeNode
  11. WithOrigin
  12. TreePatternBits
  13. Product
  14. Equals
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  2. abstract def dataFilters: Seq[Expression]
  3. abstract def disableBucketedScan: Boolean
  4. abstract 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
    DataSourceScanExec
  5. abstract def optionalBucketSet: Option[BitSet]
  6. abstract def optionalNumCoalescedBuckets: Option[Int]
  7. abstract def output: Seq[Attribute]
    Definition Classes
    FileSourceScanLike → QueryPlan
  8. abstract def partitionFilters: Seq[Expression]
  9. abstract def productArity: Int
    Definition Classes
    Product
  10. abstract def productElement(n: Int): Any
    Definition Classes
    Product
  11. abstract def relation: HadoopFsRelation
  12. abstract def requiredSchema: StructType
  13. abstract def tableIdentifier: Option[TableIdentifier]

Concrete Value Members

  1. lazy val allAttributes: AttributeSeq
    Definition Classes
    QueryPlan
  2. def apply(number: Int): TreeNode[_]
    Definition Classes
    TreeNode
  3. def argString(maxFields: Int): String
    Definition Classes
    TreeNode
  4. def asCode: String
    Definition Classes
    TreeNode
  5. lazy val bucketedScan: Boolean
  6. final lazy val canonicalized: SparkPlan
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  7. final def children: Seq[SparkPlan]
    Definition Classes
    LeafLike
  8. def clone(): SparkPlan
    Definition Classes
    TreeNode → AnyRef
  9. def collect[B](pf: PartialFunction[SparkPlan, B]): Seq[B]
    Definition Classes
    TreeNode
  10. def collectFirst[B](pf: PartialFunction[SparkPlan, B]): Option[B]
    Definition Classes
    TreeNode
  11. def collectLeaves(): Seq[SparkPlan]
    Definition Classes
    TreeNode
  12. def collectWithSubqueries[B](f: PartialFunction[SparkPlan, B]): Seq[B]
    Definition Classes
    QueryPlan
  13. def conf: SQLConf
    Definition Classes
    SparkPlan → SQLConfHelper
  14. final def containsAllPatterns(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  15. final def containsAnyPattern(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  16. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  17. final def containsPattern(t: TreePattern): Boolean
    Definition Classes
    TreePatternBits
    Annotations
    @inline()
  18. def copyTagsFrom(other: SparkPlan): Unit
    Definition Classes
    TreeNode
  19. lazy val deterministic: Boolean
    Definition Classes
    QueryPlan
  20. lazy val driverMetrics: Map[String, SQLMetric]
  21. 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
  22. 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
  23. 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
  24. 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
  25. 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
  26. 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
  27. 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
  28. 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).

  29. def executeWrite(writeFilesSpec: WriteFilesSpec): RDD[WriterCommitMessage]

    Returns the result of writes as an RDD[WriterCommitMessage] variable by delegating to doExecuteWrite after preparations.

    Returns the result of writes as an RDD[WriterCommitMessage] variable by delegating to doExecuteWrite after preparations.

    Concrete implementations of SparkPlan should override doExecuteWrite.

    Definition Classes
    SparkPlan
  30. def exists(f: (SparkPlan) => Boolean): Boolean
    Definition Classes
    TreeNode
  31. final def expressions: Seq[Expression]
    Definition Classes
    QueryPlan
  32. def fastEquals(other: TreeNode[_]): Boolean
    Definition Classes
    TreeNode
  33. lazy val fileConstantMetadataColumns: Seq[AttributeReference]
  34. def find(f: (SparkPlan) => Boolean): Option[SparkPlan]
    Definition Classes
    TreeNode
  35. def flatMap[A](f: (SparkPlan) => TraversableOnce[A]): Seq[A]
    Definition Classes
    TreeNode
  36. def foreach(f: (SparkPlan) => Unit): Unit
    Definition Classes
    TreeNode
  37. def foreachUp(f: (SparkPlan) => Unit): Unit
    Definition Classes
    TreeNode
  38. def generateTreeString(depth: Int, lastChildren: ArrayList[Boolean], append: (String) => Unit, verbose: Boolean, prefix: String, addSuffix: Boolean, maxFields: Int, printNodeId: Boolean, indent: Int): Unit
    Definition Classes
    TreeNode
  39. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  40. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  41. val id: Int
    Definition Classes
    SparkPlan
  42. def innerChildren: Seq[QueryPlan[_]]
    Definition Classes
    QueryPlan → TreeNode
  43. def inputSet: AttributeSet
    Definition Classes
    QueryPlan
  44. def logicalLink: Option[LogicalPlan]

    returns

    The logical plan this plan is linked to.

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

    returns

    SQLMetric for the name.

    Definition Classes
    SparkPlan
  46. 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
  47. def map[A](f: (SparkPlan) => A): Seq[A]
    Definition Classes
    TreeNode
  48. final def mapChildren(f: (SparkPlan) => SparkPlan): SparkPlan
    Definition Classes
    LeafLike
  49. def mapExpressions(f: (Expression) => Expression): FileSourceScanLike.this.type
    Definition Classes
    QueryPlan
  50. lazy val metadata: Map[String, String]
  51. def metrics: Map[String, SQLMetric]

    returns

    All metrics containing metrics of this SparkPlan.

    Definition Classes
    FileSourceScanLikeSparkPlan
  52. final def missingInput: AttributeSet
    Definition Classes
    QueryPlan
  53. def multiTransformDown(rule: PartialFunction[SparkPlan, Seq[SparkPlan]]): Stream[SparkPlan]
    Definition Classes
    TreeNode
  54. def multiTransformDownWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[SparkPlan, Seq[SparkPlan]]): Stream[SparkPlan]
    Definition Classes
    TreeNode
  55. val nodeName: String
    Definition Classes
    DataSourceScanExec → TreeNode
  56. def numberedTreeString: String
    Definition Classes
    TreeNode
  57. val origin: Origin
    Definition Classes
    TreeNode → WithOrigin
  58. lazy val outputOrdering: Seq[SortOrder]
    Definition Classes
    FileSourceScanLike → QueryPlan
  59. 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. Note this method may fail if it is invoked before EnsureRequirements is applied since PartitioningCollection requires all its partitionings to have the same number of partitions.

    Definition Classes
    FileSourceScanLikeSparkPlan
  60. lazy val outputSet: AttributeSet
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  61. def p(number: Int): SparkPlan
    Definition Classes
    TreeNode
  62. final def prepare(): Unit

    Prepares this SparkPlan for execution.

    Prepares this SparkPlan for execution. It's idempotent.

    Definition Classes
    SparkPlan
  63. def prettyJson: String
    Definition Classes
    TreeNode
  64. def printSchema(): Unit
    Definition Classes
    QueryPlan
  65. def producedAttributes: AttributeSet
    Definition Classes
    LeafExecNode → QueryPlan
  66. def productElementName(n: Int): String
    Definition Classes
    Product
  67. def productElementNames: Iterator[String]
    Definition Classes
    Product
  68. def productIterator: Iterator[Any]
    Definition Classes
    Product
  69. def productPrefix: String
    Definition Classes
    Product
  70. lazy val references: AttributeSet
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  71. 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
  72. 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
  73. def resetMetrics(): Unit

    Resets all the metrics.

    Resets all the metrics.

    Definition Classes
    SparkPlan
  74. def rewriteAttrs(attrMap: AttributeMap[Attribute]): SparkPlan
    Definition Classes
    QueryPlan
  75. final def sameResult(other: SparkPlan): Boolean
    Definition Classes
    QueryPlan
  76. lazy val schema: StructType
    Definition Classes
    QueryPlan
  77. def schemaString: String
    Definition Classes
    QueryPlan
  78. lazy val selectedPartitions: Array[PartitionDirectory]
    Annotations
    @transient()
  79. final def semanticHash(): Int
    Definition Classes
    QueryPlan
  80. final val session: SparkSession
    Definition Classes
    SparkPlan
  81. def setLogicalLink(logicalPlan: LogicalPlan): Unit

    Set logical plan link recursively if unset.

    Set logical plan link recursively if unset.

    Definition Classes
    SparkPlan
  82. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  83. def simpleString(maxFields: Int): String
    Definition Classes
    DataSourceScanExec → QueryPlan → TreeNode
  84. def simpleStringWithNodeId(): String
    Definition Classes
    QueryPlan → TreeNode
  85. lazy val subqueries: Seq[SparkPlan]
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  86. def subqueriesAll: Seq[SparkPlan]
    Definition Classes
    QueryPlan
  87. def supportsColumnar: Boolean

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

    Return true if this stage of the plan supports columnar execution. A plan can also support row-based execution (see supportsRowBased). Spark will decide which execution to be called during query planning.

    Definition Classes
    SparkPlan
  88. def supportsRowBased: Boolean

    Return true if this stage of the plan supports row-based execution.

    Return true if this stage of the plan supports row-based execution. A plan can also support columnar execution (see supportsColumnar). Spark will decide which execution to be called during query planning.

    Definition Classes
    SparkPlan
  89. def toJSON: String
    Definition Classes
    TreeNode
  90. def toRowBased: SparkPlan

    Converts the output of this plan to row-based if it is columnar plan.

    Converts the output of this plan to row-based if it is columnar plan.

    Definition Classes
    SparkPlan
  91. def toString(): String
    Definition Classes
    TreeNode → AnyRef → Any
  92. def transform(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  93. def transformAllExpressions(rule: PartialFunction[Expression, Expression]): FileSourceScanLike.this.type
    Definition Classes
    QueryPlan
  94. def transformAllExpressionsWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): FileSourceScanLike.this.type
    Definition Classes
    QueryPlan
  95. def transformAllExpressionsWithSubqueries(rule: PartialFunction[Expression, Expression]): FileSourceScanLike.this.type
    Definition Classes
    QueryPlan
  96. def transformDown(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  97. def transformDownWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  98. def transformDownWithSubqueries(f: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    QueryPlan
  99. def transformDownWithSubqueriesAndPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(f: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    QueryPlan
  100. def transformExpressions(rule: PartialFunction[Expression, Expression]): FileSourceScanLike.this.type
    Definition Classes
    QueryPlan
  101. def transformExpressionsDown(rule: PartialFunction[Expression, Expression]): FileSourceScanLike.this.type
    Definition Classes
    QueryPlan
  102. def transformExpressionsDownWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): FileSourceScanLike.this.type
    Definition Classes
    QueryPlan
  103. def transformExpressionsUp(rule: PartialFunction[Expression, Expression]): FileSourceScanLike.this.type
    Definition Classes
    QueryPlan
  104. def transformExpressionsUpWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): FileSourceScanLike.this.type
    Definition Classes
    QueryPlan
  105. def transformExpressionsWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): FileSourceScanLike.this.type
    Definition Classes
    QueryPlan
  106. def transformUp(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  107. def transformUpWithBeforeAndAfterRuleOnChildren(cond: (SparkPlan) => Boolean, ruleId: RuleId)(rule: PartialFunction[(SparkPlan, SparkPlan), SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  108. def transformUpWithNewOutput(rule: PartialFunction[SparkPlan, (SparkPlan, Seq[(Attribute, Attribute)])], skipCond: (SparkPlan) => Boolean, canGetOutput: (SparkPlan) => Boolean): SparkPlan
    Definition Classes
    QueryPlan
  109. def transformUpWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  110. def transformUpWithSubqueries(f: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    QueryPlan
  111. def transformWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  112. def transformWithSubqueries(f: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    QueryPlan
  113. lazy val treePatternBits: BitSet
    Definition Classes
    QueryPlan → TreeNode → TreePatternBits
  114. def treeString(append: (String) => Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  115. final def treeString(verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): String
    Definition Classes
    TreeNode
  116. final def treeString: String
    Definition Classes
    TreeNode
  117. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  118. 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
    FileSourceScanLikeSparkPlan
  119. def verboseString(maxFields: Int): String
    Definition Classes
    QueryPlan → TreeNode
  120. def verboseStringWithOperatorId(): String
    Definition Classes
    FileSourceScanLikeDataSourceScanExecLeafExecNode → QueryPlan
  121. def verboseStringWithSuffix(maxFields: Int): String
    Definition Classes
    TreeNode
  122. final def withNewChildren(newChildren: Seq[SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  123. def withNewChildrenInternal(newChildren: IndexedSeq[SparkPlan]): SparkPlan
    Definition Classes
    LeafLike