Packages

trait EvalPythonExec extends SparkPlan with UnaryExecNode

A physical plan that evaluates a PythonUDF, one partition of tuples at a time.

Python evaluation works by sending the necessary (projected) input data via a socket to an external Python process, and combine the result from the Python process with the original row.

For each row we send to Python, we also put it in a queue first. For each output row from Python, we drain the queue to find the original input row. Note that if the Python process is way too slow, this could lead to the queue growing unbounded and spill into disk when run out of memory.

Here is a diagram to show how this works:

Downstream (for parent) / \ / socket (output of UDF) / \ RowQueue Python \ / \ socket (input of UDF) \ / upstream (from child)

The rows sent to and received from Python are packed into batches (100 rows) and serialized, there should be always some rows buffered in the socket or Python process, so the pulling from RowQueue ALWAYS happened after pushing into it.

Linear Supertypes
UnaryExecNode, UnaryLike[SparkPlan], SparkPlan, Serializable, Logging, QueryPlan[SparkPlan], SQLConfHelper, TreeNode[SparkPlan], TreePatternBits, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EvalPythonExec
  2. UnaryExecNode
  3. UnaryLike
  4. SparkPlan
  5. Serializable
  6. Logging
  7. QueryPlan
  8. SQLConfHelper
  9. TreeNode
  10. TreePatternBits
  11. Product
  12. Equals
  13. AnyRef
  14. 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 child: SparkPlan
    Definition Classes
    UnaryLike
  3. abstract def productArity: Int
    Definition Classes
    Product
  4. abstract def productElement(n: Int): Any
    Definition Classes
    Product
  5. abstract def resultAttrs: Seq[Attribute]
  6. abstract def udfs: Seq[PythonUDF]

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. final lazy val canonicalized: SparkPlan
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  6. final lazy val children: Seq[SparkPlan]
    Definition Classes
    UnaryLike
    Annotations
    @transient()
  7. def clone(): SparkPlan
    Definition Classes
    TreeNode → AnyRef
  8. def collect[B](pf: PartialFunction[SparkPlan, B]): Seq[B]
    Definition Classes
    TreeNode
  9. def collectFirst[B](pf: PartialFunction[SparkPlan, B]): Option[B]
    Definition Classes
    TreeNode
  10. def collectLeaves(): Seq[SparkPlan]
    Definition Classes
    TreeNode
  11. def collectWithSubqueries[B](f: PartialFunction[SparkPlan, B]): Seq[B]
    Definition Classes
    QueryPlan
  12. def conf: SQLConf
    Definition Classes
    SparkPlan → SQLConfHelper
  13. final def containsAllPatterns(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  14. final def containsAnyPattern(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  15. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  16. final def containsPattern(t: TreePattern): Boolean
    Definition Classes
    TreePatternBits
    Annotations
    @inline()
  17. def copyTagsFrom(other: SparkPlan): Unit
    Definition Classes
    TreeNode
  18. lazy val deterministic: Boolean
    Definition Classes
    QueryPlan
  19. 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
  20. 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
  21. 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
  22. 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
  23. 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
  24. 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
  25. 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
  26. 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).

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

    returns

    The logical plan this plan is linked to.

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

    returns

    SQLMetric for the name.

    Definition Classes
    SparkPlan
  42. 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
  43. def map[A](f: (SparkPlan) => A): Seq[A]
    Definition Classes
    TreeNode
  44. final def mapChildren(f: (SparkPlan) => SparkPlan): SparkPlan
    Definition Classes
    UnaryLike
  45. def mapExpressions(f: (Expression) => Expression): EvalPythonExec.this.type
    Definition Classes
    QueryPlan
  46. def metrics: Map[String, SQLMetric]

    returns

    All metrics containing metrics of this SparkPlan.

    Definition Classes
    SparkPlan
  47. final def missingInput: AttributeSet
    Definition Classes
    QueryPlan
  48. def nodeName: String
    Definition Classes
    TreeNode
  49. def numberedTreeString: String
    Definition Classes
    TreeNode
  50. val origin: Origin
    Definition Classes
    TreeNode
  51. def output: Seq[Attribute]
    Definition Classes
    EvalPythonExec → QueryPlan
  52. def outputOrdering: Seq[SortOrder]

    Specifies how data is ordered in each partition.

    Specifies how data is ordered in each partition.

    Definition Classes
    SparkPlan
  53. def 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
    SparkPlan
  54. lazy val outputSet: AttributeSet
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  55. def p(number: Int): SparkPlan
    Definition Classes
    TreeNode
  56. final def prepare(): Unit

    Prepares this SparkPlan for execution.

    Prepares this SparkPlan for execution. It's idempotent.

    Definition Classes
    SparkPlan
  57. def prettyJson: String
    Definition Classes
    TreeNode
  58. def printSchema(): Unit
    Definition Classes
    QueryPlan
  59. def producedAttributes: AttributeSet
    Definition Classes
    EvalPythonExec → QueryPlan
  60. def productElementName(n: Int): String
    Definition Classes
    Product
  61. def productElementNames: Iterator[String]
    Definition Classes
    Product
  62. def productIterator: Iterator[Any]
    Definition Classes
    Product
  63. def productPrefix: String
    Definition Classes
    Product
  64. lazy val references: AttributeSet
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  65. 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
  66. 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
  67. def resetMetrics(): Unit

    Resets all the metrics.

    Resets all the metrics.

    Definition Classes
    SparkPlan
  68. def rewriteAttrs(attrMap: AttributeMap[Attribute]): SparkPlan
    Definition Classes
    QueryPlan
  69. final def sameResult(other: SparkPlan): Boolean
    Definition Classes
    QueryPlan
  70. lazy val schema: StructType
    Definition Classes
    QueryPlan
  71. def schemaString: String
    Definition Classes
    QueryPlan
  72. final def semanticHash(): Int
    Definition Classes
    QueryPlan
  73. final val session: SparkSession
    Definition Classes
    SparkPlan
  74. def setLogicalLink(logicalPlan: LogicalPlan): Unit

    Set logical plan link recursively if unset.

    Set logical plan link recursively if unset.

    Definition Classes
    SparkPlan
  75. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  76. def simpleString(maxFields: Int): String
    Definition Classes
    QueryPlan → TreeNode
  77. def simpleStringWithNodeId(): String
    Definition Classes
    QueryPlan → TreeNode
  78. lazy val subqueries: Seq[SparkPlan]
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  79. def subqueriesAll: Seq[SparkPlan]
    Definition Classes
    QueryPlan
  80. 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
  81. 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
  82. def toJSON: String
    Definition Classes
    TreeNode
  83. 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
  84. def toString(): String
    Definition Classes
    TreeNode → AnyRef → Any
  85. def transform(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  86. def transformAllExpressions(rule: PartialFunction[Expression, Expression]): EvalPythonExec.this.type
    Definition Classes
    QueryPlan
  87. def transformAllExpressionsWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): EvalPythonExec.this.type
    Definition Classes
    QueryPlan
  88. def transformDown(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  89. def transformDownWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  90. def transformDownWithSubqueries(f: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    QueryPlan
  91. def transformDownWithSubqueriesAndPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(f: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    QueryPlan
  92. def transformExpressions(rule: PartialFunction[Expression, Expression]): EvalPythonExec.this.type
    Definition Classes
    QueryPlan
  93. def transformExpressionsDown(rule: PartialFunction[Expression, Expression]): EvalPythonExec.this.type
    Definition Classes
    QueryPlan
  94. def transformExpressionsDownWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): EvalPythonExec.this.type
    Definition Classes
    QueryPlan
  95. def transformExpressionsUp(rule: PartialFunction[Expression, Expression]): EvalPythonExec.this.type
    Definition Classes
    QueryPlan
  96. def transformExpressionsUpWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): EvalPythonExec.this.type
    Definition Classes
    QueryPlan
  97. def transformExpressionsWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): EvalPythonExec.this.type
    Definition Classes
    QueryPlan
  98. def transformUp(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  99. def transformUpWithBeforeAndAfterRuleOnChildren(cond: (SparkPlan) => Boolean, ruleId: RuleId)(rule: PartialFunction[(SparkPlan, SparkPlan), SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  100. def transformUpWithNewOutput(rule: PartialFunction[SparkPlan, (SparkPlan, Seq[(Attribute, Attribute)])], skipCond: (SparkPlan) => Boolean, canGetOutput: (SparkPlan) => Boolean): SparkPlan
    Definition Classes
    QueryPlan
  101. def transformUpWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  102. def transformUpWithSubqueries(f: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    QueryPlan
  103. def transformWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  104. def transformWithSubqueries(f: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    QueryPlan
  105. lazy val treePatternBits: BitSet
    Definition Classes
    QueryPlan → TreeNode → TreePatternBits
  106. def treeString(append: (String) => Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  107. final def treeString(verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): String
    Definition Classes
    TreeNode
  108. final def treeString: String
    Definition Classes
    TreeNode
  109. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  110. 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
    SparkPlan
  111. def verboseString(maxFields: Int): String
    Definition Classes
    QueryPlan → TreeNode
  112. def verboseStringWithOperatorId(): String
    Definition Classes
    UnaryExecNode → QueryPlan
  113. def verboseStringWithSuffix(maxFields: Int): String
    Definition Classes
    TreeNode
  114. final def withNewChildren(newChildren: Seq[SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  115. final def withNewChildrenInternal(newChildren: IndexedSeq[SparkPlan]): SparkPlan
    Definition Classes
    UnaryLike