Packages

c

org.apache.spark.sql.execution.python

FlatMapGroupsInPandasExec

case class FlatMapGroupsInPandasExec(groupingAttributes: Seq[Attribute], func: Expression, output: Seq[Attribute], child: SparkPlan) extends SparkPlan with UnaryExecNode with Product with Serializable

Physical node for org.apache.spark.sql.catalyst.plans.logical.FlatMapGroupsInPandas

Rows in each group are passed to the Python worker as an Arrow record batch. The Python worker turns the record batch to a pandas.DataFrame, invoke the user-defined function, and passes the resulting pandas.DataFrame as an Arrow record batch. Finally, each record batch is turned to Iterator[InternalRow] using ColumnarBatch.

Note on memory usage: Both the Python worker and the Java executor need to have enough memory to hold the largest group. The memory on the Java side is used to construct the record batch (off heap memory). The memory on the Python side is used for holding the pandas.DataFrame. It's possible to further split one group into multiple record batches to reduce the memory footprint on the Java side, this is left as future work.

Linear Supertypes
UnaryExecNode, UnaryLike[SparkPlan], SparkPlan, Serializable, Serializable, Logging, QueryPlan[SparkPlan], SQLConfHelper, TreeNode[SparkPlan], TreePatternBits, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FlatMapGroupsInPandasExec
  2. UnaryExecNode
  3. UnaryLike
  4. SparkPlan
  5. Serializable
  6. Serializable
  7. Logging
  8. QueryPlan
  9. SQLConfHelper
  10. TreeNode
  11. TreePatternBits
  12. Product
  13. Equals
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FlatMapGroupsInPandasExec(groupingAttributes: Seq[Attribute], func: Expression, output: Seq[Attribute], child: SparkPlan)

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. val child: SparkPlan
    Definition Classes
    FlatMapGroupsInPandasExec → UnaryLike
  7. final lazy val children: Seq[SparkPlan]
    Definition Classes
    UnaryLike
    Annotations
    @transient()
  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. 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. final def expressions: Seq[Expression]
    Definition Classes
    QueryPlan
  28. def fastEquals(other: TreeNode[_]): Boolean
    Definition Classes
    TreeNode
  29. def find(f: (SparkPlan) ⇒ Boolean): Option[SparkPlan]
    Definition Classes
    TreeNode
  30. def flatMap[A](f: (SparkPlan) ⇒ TraversableOnce[A]): Seq[A]
    Definition Classes
    TreeNode
  31. def foreach(f: (SparkPlan) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  32. def foreachUp(f: (SparkPlan) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  33. val func: Expression
  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. val groupingAttributes: Seq[Attribute]
  37. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  38. val id: Int
    Definition Classes
    SparkPlan
  39. def innerChildren: Seq[QueryPlan[_]]
    Definition Classes
    QueryPlan → TreeNode
  40. def inputSet: AttributeSet
    Definition Classes
    QueryPlan
  41. def logicalLink: Option[LogicalPlan]

    returns

    The logical plan this plan is linked to.

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

    returns

    SQLMetric for the name.

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

    returns

    All metrics containing metrics of this SparkPlan.

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

    Specifies how data is ordered in each partition.

    Specifies how data is ordered in each partition.

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

    Prepares this SparkPlan for execution.

    Prepares this SparkPlan for execution. It's idempotent.

    Definition Classes
    SparkPlan
  58. def prettyJson: String
    Definition Classes
    TreeNode
  59. def printSchema(): Unit
    Definition Classes
    QueryPlan
  60. def producedAttributes: AttributeSet
    Definition Classes
    FlatMapGroupsInPandasExec → QueryPlan
  61. lazy val references: AttributeSet
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  62. 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
    FlatMapGroupsInPandasExec → SparkPlan
  63. 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
    FlatMapGroupsInPandasExec → SparkPlan
  64. def resetMetrics(): Unit

    Resets all the metrics.

    Resets all the metrics.

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

    Set logical plan link recursively if unset.

    Set logical plan link recursively if unset.

    Definition Classes
    SparkPlan
  72. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  73. def simpleString(maxFields: Int): String
    Definition Classes
    QueryPlan → TreeNode
  74. def simpleStringWithNodeId(): String
    Definition Classes
    QueryPlan → TreeNode
  75. def subqueries: Seq[SparkPlan]
    Definition Classes
    QueryPlan
  76. def subqueriesAll: Seq[SparkPlan]
    Definition Classes
    QueryPlan
  77. 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.

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