org.apache.spark.sql.execution.python

BatchEvalPythonExec

case class BatchEvalPythonExec(udfs: Seq[PythonUDF], output: Seq[Attribute], child: SparkPlan) extends SparkPlan with Product with Serializable

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
SparkPlan, Serializable, Serializable, Logging, QueryPlan[SparkPlan], TreeNode[SparkPlan], Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BatchEvalPythonExec
  2. SparkPlan
  3. Serializable
  4. Serializable
  5. Logging
  6. QueryPlan
  7. TreeNode
  8. Product
  9. Equals
  10. AnyRef
  11. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BatchEvalPythonExec(udfs: Seq[PythonUDF], output: Seq[Attribute], child: SparkPlan)

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: SparkPlan

    Definition Classes
    QueryPlan
  12. val child: SparkPlan

  13. def children: Seq[SparkPlan]

    Definition Classes
    BatchEvalPythonExec → TreeNode
  14. def clone(): AnyRef

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

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

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

    Definition Classes
    TreeNode
  18. lazy val constraints: ExpressionSet

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

    Definition Classes
    TreeNode
  20. 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
    BatchEvalPythonExecSparkPlan
  21. 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
  22. 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
  23. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  24. 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
  25. 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
  26. 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
  27. 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
  28. 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
  29. 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
  30. 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
  31. final def expressions: Seq[Expression]

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

    Definition Classes
    TreeNode
  33. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  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: Seq[Boolean], builder: StringBuilder, verbose: Boolean, prefix: String, addSuffix: Boolean): StringBuilder

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

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

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

    Definition Classes
    TreeNode → AnyRef → Any
  42. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

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

    Attributes
    protected
    Definition Classes
    QueryPlan → TreeNode
  44. def inputSet: AttributeSet

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

    Definition Classes
    Any
  46. def isTraceEnabled(): Boolean

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

    Attributes
    protected
    Definition Classes
    TreeNode
  48. def log: Logger

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

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

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

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

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

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

    Attributes
    protected
    Definition Classes
    Logging
  55. def logName: String

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

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

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

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

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

    Return a LongSQLMetric according to the name.

    Return a LongSQLMetric according to the name.

    Definition Classes
    SparkPlan
  61. 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
  62. def map[A](f: (SparkPlan) ⇒ A): Seq[A]

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

    Definition Classes
    TreeNode
  64. def mapExpressions(f: (Expression) ⇒ Expression): BatchEvalPythonExec.this.type

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

    Attributes
    protected
    Definition Classes
    TreeNode
  66. def 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
    SparkPlan
  67. def metrics: Map[String, SQLMetric]

    Return all metrics containing metrics of this SparkPlan.

    Return all metrics containing metrics of this SparkPlan.

    Definition Classes
    SparkPlan
  68. def missingInput: AttributeSet

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

    Definition Classes
    AnyRef
  70. def newMutableProjection(expressions: Seq[Expression], inputSchema: Seq[Attribute], useSubexprElimination: Boolean = false): MutableProjection

    Attributes
    protected
    Definition Classes
    SparkPlan
  71. 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
  72. def newOrdering(order: Seq[SortOrder], inputSchema: Seq[Attribute]): Ordering[InternalRow]

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

    Attributes
    protected
    Definition Classes
    SparkPlan
  74. def nodeName: String

    Definition Classes
    TreeNode
  75. final def notify(): Unit

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

    Definition Classes
    AnyRef
  77. def numberedTreeString: String

    Definition Classes
    TreeNode
  78. val origin: Origin

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

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

    Definition Classes
    BatchEvalPythonExec → QueryPlan
  81. def outputOrdering: Seq[SortOrder]

    Specifies how data is ordered in each partition.

    Specifies how data is ordered in each partition.

    Definition Classes
    SparkPlan
  82. 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.

    Definition Classes
    SparkPlan
  83. def outputSet: AttributeSet

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

    Definition Classes
    TreeNode
  85. def preCanonicalized: SparkPlan

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

    Prepare a SparkPlan for execution.

    Prepare a SparkPlan for execution. It's idempotent.

    Definition Classes
    SparkPlan
  87. 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
  88. def prettyJson: String

    Definition Classes
    TreeNode
  89. def printSchema(): Unit

    Definition Classes
    QueryPlan
  90. def producedAttributes: AttributeSet

    Definition Classes
    BatchEvalPythonExec → QueryPlan
  91. def references: AttributeSet

    Definition Classes
    QueryPlan
  92. 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
  93. 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
  94. def resetMetrics(): Unit

    Reset all the metrics.

    Reset all the metrics.

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

    Definition Classes
    QueryPlan
  96. lazy val schema: StructType

    Definition Classes
    QueryPlan
  97. def schemaString: String

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

    Definition Classes
    QueryPlan
  99. def simpleString: String

    Definition Classes
    QueryPlan → TreeNode
  100. def sparkContext: SparkContext

    Attributes
    protected
    Definition Classes
    SparkPlan
  101. 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
  102. def statePrefix: String

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

    Attributes
    protected
    Definition Classes
    TreeNode
  104. val subexpressionEliminationEnabled: Boolean

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

    Definition Classes
    QueryPlan
  106. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  107. def toJSON: String

    Definition Classes
    TreeNode
  108. def toString(): String

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

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

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

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

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

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

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

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

    Definition Classes
    TreeNode
  117. def treeString: String

    Definition Classes
    TreeNode
  118. val udfs: Seq[PythonUDF]

  119. def validConstraints: Set[Expression]

    Attributes
    protected
    Definition Classes
    QueryPlan
  120. def verboseString: String

    Definition Classes
    QueryPlan → TreeNode
  121. def verboseStringWithSuffix: String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  125. 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
  126. def withNewChildren(newChildren: Seq[SparkPlan]): SparkPlan

    Definition Classes
    TreeNode

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