Class

org.apache.spark.sql.execution.streaming

FlatMapGroupsWithStateExec

Related Doc: package streaming

Permalink

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
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)

    Permalink

    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

    Permalink

    Helper class to update the state store

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. lazy val allAttributes: AttributeSeq

    Permalink
    Definition Classes
    QueryPlan
  5. def apply(number: Int): TreeNode[_]

    Permalink
    Definition Classes
    TreeNode
  6. def argString: String

    Permalink
    Definition Classes
    TreeNode
  7. def asCode: String

    Permalink
    Definition Classes
    TreeNode
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. val batchTimestampMs: Option[Long]

    Permalink

    processing timestamp of the current batch.

  10. lazy val canonicalized: SparkPlan

    Permalink
    Definition Classes
    QueryPlan
  11. val child: SparkPlan

    Permalink
  12. final def children: Seq[SparkPlan]

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

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

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

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

    Permalink
    Definition Classes
    TreeNode
  17. lazy val constraints: ExpressionSet

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

    Permalink
    Definition Classes
    TreeNode
  19. val dataAttributes: Seq[Attribute]

    Permalink

    used to read the data

  20. def doExecute(): RDD[InternalRow]

    Permalink

    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
  21. def doExecuteBroadcast[T](): Broadcast[T]

    Permalink

    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

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef
  24. val eventTimeWatermark: Option[Long]

    Permalink

    The watermark value.

    The watermark value.

    Definition Classes
    FlatMapGroupsWithStateExecWatermarkSupport
  25. final def execute(): RDD[InternalRow]

    Permalink

    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
  26. final def executeBroadcast[T](): Broadcast[T]

    Permalink

    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
  27. def executeCollect(): Array[InternalRow]

    Permalink

    Runs this query returning the result as an array.

    Runs this query returning the result as an array.

    Definition Classes
    SparkPlan
  28. def executeCollectPublic(): Array[Row]

    Permalink

    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
  29. final def executeQuery[T](query: ⇒ T): T

    Permalink

    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
  30. def executeTake(n: Int): Array[InternalRow]

    Permalink

    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
  31. def executeToIterator(): Iterator[InternalRow]

    Permalink

    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
  32. final def expressions: Seq[Expression]

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

    Permalink
    Definition Classes
    TreeNode
  34. def finalize(): Unit

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

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

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

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

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

    Permalink

    function called on each group

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    QueryPlan
  43. def getStateId: OperatorStateId

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

    Permalink

    used to group the data

  45. def hashCode(): Int

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

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

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

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

    Permalink
    Definition Classes
    Any
  50. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  51. def jsonFields: List[JField]

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode
  52. val keyDeserializer: Expression

    Permalink

    used to extract the key object for each group.

  53. def keyExpressions: Seq[Attribute]

    Permalink

    The keys that may have a watermark attribute.

    The keys that may have a watermark attribute.

    Definition Classes
    FlatMapGroupsWithStateExecWatermarkSupport
  54. def log: Logger

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  61. def logName: String

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

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

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

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

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

    Permalink

    Return a LongSQLMetric according to the name.

    Return a LongSQLMetric according to the name.

    Definition Classes
    SparkPlan
  67. def makeCopy(newArgs: Array[AnyRef]): SparkPlan

    Permalink

    Overridden make copy also propagates sqlContext to copied plan.

    Overridden make copy also propagates sqlContext to copied plan.

    Definition Classes
    SparkPlan → TreeNode
  68. def map[A](f: (SparkPlan) ⇒ A): Seq[A]

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode
  72. def metadata: Map[String, String]

    Permalink

    Return all metadata that describes more details of this SparkPlan.

    Return all metadata that describes more details of this SparkPlan.

    Definition Classes
    SparkPlan
  73. lazy val metrics: Map[String, SQLMetric]

    Permalink

    Return all metrics containing metrics of this SparkPlan.

    Return all metrics containing metrics of this SparkPlan.

    Definition Classes
    StateStoreWriterSparkPlan
  74. def missingInput: AttributeSet

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    SparkPlan
  77. def newNaturalAscendingOrdering(dataTypes: Seq[DataType]): Ordering[InternalRow]

    Permalink

    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
  78. def newOrdering(order: Seq[SortOrder], inputSchema: Seq[Attribute]): Ordering[InternalRow]

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

    Permalink
    Attributes
    protected
    Definition Classes
    SparkPlan
  80. def nodeName: String

    Permalink
    Definition Classes
    TreeNode
  81. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  82. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  83. def numberedTreeString: String

    Permalink
    Definition Classes
    TreeNode
  84. val origin: Origin

    Permalink
    Definition Classes
    TreeNode
  85. def otherCopyArgs: Seq[AnyRef]

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

    Permalink
    Definition Classes
    ObjectProducerExec → QueryPlan
  87. val outputMode: OutputMode

    Permalink

    the output mode of func

  88. val outputObjAttr: Attribute

    Permalink

    used to define the output object

    used to define the output object

    Definition Classes
    FlatMapGroupsWithStateExecObjectProducerExec
  89. def outputObjectType: DataType

    Permalink
    Definition Classes
    ObjectProducerExec
  90. def outputOrdering: Seq[SortOrder]

    Permalink

    Specifies how data is ordered in each partition.

    Specifies how data is ordered in each partition.

    Definition Classes
    SparkPlan
  91. def outputPartitioning: Partitioning

    Permalink

    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
  92. def outputSet: AttributeSet

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

    Permalink
    Definition Classes
    TreeNode
  94. def preCanonicalized: SparkPlan

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

    Permalink

    Prepare a SparkPlan for execution.

    Prepare a SparkPlan for execution. It's idempotent.

    Definition Classes
    SparkPlan
  96. def prepareSubqueries(): Unit

    Permalink

    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
  97. def prettyJson: String

    Permalink
    Definition Classes
    TreeNode
  98. def printSchema(): Unit

    Permalink
    Definition Classes
    QueryPlan
  99. def producedAttributes: AttributeSet

    Permalink
    Definition Classes
    ObjectProducerExec → QueryPlan
  100. def references: AttributeSet

    Permalink
    Definition Classes
    QueryPlan
  101. def requiredChildDistribution: Seq[Distribution]

    Permalink

    Distribute by grouping attributes

    Distribute by grouping attributes

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

    Permalink

    Ordering needed for using GroupingIterator

    Ordering needed for using GroupingIterator

    Definition Classes
    FlatMapGroupsWithStateExecSparkPlan
  103. def resetMetrics(): Unit

    Permalink

    Reset all the metrics.

    Reset all the metrics.

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

    Permalink
    Definition Classes
    QueryPlan
  105. lazy val schema: StructType

    Permalink
    Definition Classes
    QueryPlan
  106. def schemaString: String

    Permalink
    Definition Classes
    QueryPlan
  107. final def semanticHash(): Int

    Permalink
    Definition Classes
    QueryPlan
  108. def simpleString: String

    Permalink
    Definition Classes
    QueryPlan → TreeNode
  109. def sparkContext: SparkContext

    Permalink
    Attributes
    protected
    Definition Classes
    SparkPlan
  110. final val sqlContext: SQLContext

    Permalink

    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
  111. val stateEncoder: ExpressionEncoder[Any]

    Permalink

    used to serialize/deserialize state before calling func

  112. val stateId: Option[OperatorStateId]

    Permalink
  113. def statePrefix: String

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

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode
  115. val subexpressionEliminationEnabled: Boolean

    Permalink
    Definition Classes
    SparkPlan
  116. def subqueries: Seq[SparkPlan]

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

    Permalink
    Definition Classes
    AnyRef
  118. val timeoutConf: GroupStateTimeout

    Permalink

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

  119. def toJSON: String

    Permalink
    Definition Classes
    TreeNode
  120. def toString(): String

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    TreeNode
  129. def treeString: String

    Permalink
    Definition Classes
    TreeNode
  130. def validConstraints: Set[Expression]

    Permalink
    Attributes
    protected
    Definition Classes
    QueryPlan
  131. val valueDeserializer: Expression

    Permalink

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

  132. def verboseString: String

    Permalink
    Definition Classes
    QueryPlan → TreeNode
  133. def verboseStringWithSuffix: String

    Permalink
    Definition Classes
    TreeNode
  134. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  137. def waitForSubqueries(): Unit

    Permalink

    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
  138. lazy val watermarkExpression: Option[Expression]

    Permalink

    Generate an expression that matches data older than the watermark

    Generate an expression that matches data older than the watermark

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

    Permalink

    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
  140. lazy val watermarkPredicateForKeys: Option[Predicate]

    Permalink

    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
  141. def withNewChildren(newChildren: Seq[SparkPlan]): SparkPlan

    Permalink
    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