org.apache.spark.sql.execution.streaming

FlatMapGroupsWithStateExec

case class FlatMapGroupsWithStateExec(func: (Any, Iterator[Any], LogicalGroupState[Any]) ⇒ Iterator[Any], keyDeserializer: Expression, valueDeserializer: Expression, groupingAttributes: Seq[Attribute], dataAttributes: Seq[Attribute], outputObjAttr: Attribute, stateId: Option[OperatorStateId], stateEncoder: ExpressionEncoder[Any], outputMode: OutputMode, timeoutConf: GroupStateTimeout, batchTimestampMs: Option[Long], eventTimeWatermark: Option[Long], child: SparkPlan) extends SparkPlan with UnaryExecNode with ObjectProducerExec with StateStoreWriter with WatermarkSupport with Product with Serializable

Physical operator for executing FlatMapGroupsWithState.

func

function called on each group

keyDeserializer

used to extract the key object for each group.

valueDeserializer

used to extract the items in the iterator from an input row.

groupingAttributes

used to group the data

dataAttributes

used to read the data

outputObjAttr

used to define the output object

stateEncoder

used to serialize/deserialize state before calling func

outputMode

the output mode of func

timeoutConf

used to timeout groups that have not received data in a while

batchTimestampMs

processing timestamp of the current batch.

Linear Supertypes
WatermarkSupport, StateStoreWriter, StatefulOperator, ObjectProducerExec, UnaryExecNode, SparkPlan, Serializable, Serializable, Logging, QueryPlan[SparkPlan], TreeNode[SparkPlan], Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FlatMapGroupsWithStateExec
  2. WatermarkSupport
  3. StateStoreWriter
  4. StatefulOperator
  5. ObjectProducerExec
  6. UnaryExecNode
  7. SparkPlan
  8. Serializable
  9. Serializable
  10. Logging
  11. QueryPlan
  12. TreeNode
  13. Product
  14. Equals
  15. AnyRef
  16. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FlatMapGroupsWithStateExec(func: (Any, Iterator[Any], LogicalGroupState[Any]) ⇒ Iterator[Any], keyDeserializer: Expression, valueDeserializer: Expression, groupingAttributes: Seq[Attribute], dataAttributes: Seq[Attribute], outputObjAttr: Attribute, stateId: Option[OperatorStateId], stateEncoder: ExpressionEncoder[Any], outputMode: OutputMode, timeoutConf: GroupStateTimeout, batchTimestampMs: Option[Long], eventTimeWatermark: Option[Long], child: SparkPlan)

    func

    function called on each group

    keyDeserializer

    used to extract the key object for each group.

    valueDeserializer

    used to extract the items in the iterator from an input row.

    groupingAttributes

    used to group the data

    dataAttributes

    used to read the data

    outputObjAttr

    used to define the output object

    stateEncoder

    used to serialize/deserialize state before calling func

    outputMode

    the output mode of func

    timeoutConf

    used to timeout groups that have not received data in a while

    batchTimestampMs

    processing timestamp of the current batch.

Type Members

  1. class StateStoreUpdater extends AnyRef

    Helper class to update the state store

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. val batchTimestampMs: Option[Long]

    processing timestamp of the current batch.

  12. lazy val canonicalized: SparkPlan

    Definition Classes
    QueryPlan
  13. val child: SparkPlan

  14. final def children: Seq[SparkPlan]

    Definition Classes
    UnaryExecNode → TreeNode
  15. def clone(): AnyRef

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

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

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

    Definition Classes
    TreeNode
  19. lazy val constraints: ExpressionSet

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

    Definition Classes
    TreeNode
  21. val dataAttributes: Seq[Attribute]

    used to read the data

  22. 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
    FlatMapGroupsWithStateExecSparkPlan
  23. 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
  24. 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
  25. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. val eventTimeWatermark: Option[Long]

    The watermark value.

    The watermark value.

    Definition Classes
    FlatMapGroupsWithStateExecWatermarkSupport
  27. 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
  28. 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
  29. 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
  30. 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
  31. 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
  32. 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
  33. 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
  34. final def expressions: Seq[Expression]

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

    Definition Classes
    TreeNode
  36. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  37. def find(f: (SparkPlan) ⇒ Boolean): Option[SparkPlan]

    Definition Classes
    TreeNode
  38. def flatMap[A](f: (SparkPlan) ⇒ TraversableOnce[A]): Seq[A]

    Definition Classes
    TreeNode
  39. def foreach(f: (SparkPlan) ⇒ Unit): Unit

    Definition Classes
    TreeNode
  40. def foreachUp(f: (SparkPlan) ⇒ Unit): Unit

    Definition Classes
    TreeNode
  41. val func: (Any, Iterator[Any], LogicalGroupState[Any]) ⇒ Iterator[Any]

    function called on each group

  42. def generateTreeString(depth: Int, lastChildren: Seq[Boolean], builder: StringBuilder, verbose: Boolean, prefix: String, addSuffix: Boolean): StringBuilder

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

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

    Attributes
    protected
    Definition Classes
    QueryPlan
  45. def getStateId: OperatorStateId

    Attributes
    protected
    Definition Classes
    StatefulOperator
  46. val groupingAttributes: Seq[Attribute]

    used to group the data

  47. def hashCode(): Int

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

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

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

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

    Definition Classes
    Any
  52. def isTraceEnabled(): Boolean

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

    Attributes
    protected
    Definition Classes
    TreeNode
  54. val keyDeserializer: Expression

    used to extract the key object for each group.

  55. def keyExpressions: Seq[Attribute]

    The keys that may have a watermark attribute.

    The keys that may have a watermark attribute.

    Definition Classes
    FlatMapGroupsWithStateExecWatermarkSupport
  56. def log: Logger

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

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

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

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

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

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

    Attributes
    protected
    Definition Classes
    Logging
  63. def logName: String

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

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

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

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

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

    Return a LongSQLMetric according to the name.

    Return a LongSQLMetric according to the name.

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

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

    Definition Classes
    TreeNode
  72. def mapExpressions(f: (Expression) ⇒ Expression): FlatMapGroupsWithStateExec.this.type

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

    Attributes
    protected
    Definition Classes
    TreeNode
  74. 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
  75. lazy val metrics: Map[String, SQLMetric]

    Definition Classes
    StateStoreWriterSparkPlan
  76. def missingInput: AttributeSet

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

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

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

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

    Attributes
    protected
    Definition Classes
    SparkPlan
  82. def nodeName: String

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

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

    Definition Classes
    AnyRef
  85. def numberedTreeString: String

    Definition Classes
    TreeNode
  86. val origin: Origin

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

    Attributes
    protected
    Definition Classes
    TreeNode
  88. def output: Seq[Attribute]

    Definition Classes
    ObjectProducerExec → QueryPlan
  89. val outputMode: OutputMode

    the output mode of func

  90. val outputObjAttr: Attribute

    used to define the output object

    used to define the output object

    Definition Classes
    FlatMapGroupsWithStateExecObjectProducerExec
  91. def outputObjectType: DataType

    Definition Classes
    ObjectProducerExec
  92. def outputOrdering: Seq[SortOrder]

    Specifies how data is ordered in each partition.

    Specifies how data is ordered in each partition.

    Definition Classes
    SparkPlan
  93. 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
  94. def outputSet: AttributeSet

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

    Definition Classes
    TreeNode
  96. def preCanonicalized: SparkPlan

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

    Prepare a SparkPlan for execution.

    Prepare a 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
    ObjectProducerExec → QueryPlan
  102. def references: AttributeSet

    Definition Classes
    QueryPlan
  103. def requiredChildDistribution: Seq[Distribution]

    Distribute by grouping attributes

    Distribute by grouping attributes

    Definition Classes
    FlatMapGroupsWithStateExecSparkPlan
  104. def requiredChildOrdering: Seq[Seq[SortOrder]]

    Ordering needed for using GroupingIterator

    Ordering needed for using GroupingIterator

    Definition Classes
    FlatMapGroupsWithStateExecSparkPlan
  105. def resetMetrics(): Unit

    Reset all the metrics.

    Reset all the metrics.

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

    Definition Classes
    QueryPlan
  107. lazy val schema: StructType

    Definition Classes
    QueryPlan
  108. def schemaString: String

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

    Definition Classes
    QueryPlan
  110. def simpleString: String

    Definition Classes
    QueryPlan → TreeNode
  111. def sparkContext: SparkContext

    Attributes
    protected
    Definition Classes
    SparkPlan
  112. 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
  113. val stateEncoder: ExpressionEncoder[Any]

    used to serialize/deserialize state before calling func

  114. val stateId: Option[OperatorStateId]

  115. def statePrefix: String

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

    Attributes
    protected
    Definition Classes
    TreeNode
  117. val subexpressionEliminationEnabled: Boolean

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

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

    Definition Classes
    AnyRef
  120. val timeoutConf: GroupStateTimeout

    used to timeout groups that have not received data in a while

  121. def toJSON: String

    Definition Classes
    TreeNode
  122. def toString(): String

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

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

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

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

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

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

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

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

    Definition Classes
    TreeNode
  131. def treeString: String

    Definition Classes
    TreeNode
  132. def validConstraints: Set[Expression]

    Attributes
    protected
    Definition Classes
    QueryPlan
  133. val valueDeserializer: Expression

    used to extract the items in the iterator from an input row.

  134. def verboseString: String

    Definition Classes
    QueryPlan → TreeNode
  135. def verboseStringWithSuffix: String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  139. 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
  140. lazy val watermarkExpression: Option[Expression]

    Generate an expression that matches data older than the watermark

    Generate an expression that matches data older than the watermark

    Definition Classes
    WatermarkSupport
  141. lazy val watermarkPredicateForData: Option[Predicate]

    Predicate based on the child output that matches data older than the watermark.

    Predicate based on the child output that matches data older than the watermark.

    Definition Classes
    WatermarkSupport
  142. lazy val watermarkPredicateForKeys: Option[Predicate]

    Predicate based on keys that matches data older than the watermark

    Predicate based on keys that matches data older than the watermark

    Definition Classes
    WatermarkSupport
  143. def withNewChildren(newChildren: Seq[SparkPlan]): SparkPlan

    Definition Classes
    TreeNode

Inherited from WatermarkSupport

Inherited from StateStoreWriter

Inherited from StatefulOperator

Inherited from ObjectProducerExec

Inherited from UnaryExecNode

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