Packages

c

org.apache.spark.sql.catalyst.plans.physical

StatefulOpClusteredDistribution

case class StatefulOpClusteredDistribution(expressions: Seq[Expression], _requiredNumPartitions: Int) extends Distribution with Product with Serializable

Represents the requirement of distribution on the stateful operator in Structured Streaming.

Each partition in stateful operator initializes state store(s), which are independent with state store(s) in other partitions. Since it is not possible to repartition the data in state store, Spark should make sure the physical partitioning of the stateful operator is unchanged across Spark versions. Violation of this requirement may bring silent correctness issue.

Since this distribution relies on HashPartitioning on the physical partitioning of the stateful operator, only HashPartitioning (and HashPartitioning in PartitioningCollection) can satisfy this distribution. When _requiredNumPartitions is 1, SinglePartition is essentially same as HashPartitioning, so it can satisfy this distribution as well.

NOTE: This is applied only to stream-stream join as of now. For other stateful operators, we have been using ClusteredDistribution, which could construct the physical partitioning of the state in different way (ClusteredDistribution requires relaxed condition and multiple partitionings can satisfy the requirement.) We need to construct the way to fix this with minimizing possibility to break the existing checkpoints.

TODO(SPARK-38204): address the issue explained in above note.

Linear Supertypes
Serializable, Product, Equals, Distribution, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StatefulOpClusteredDistribution
  2. Serializable
  3. Product
  4. Equals
  5. Distribution
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new StatefulOpClusteredDistribution(expressions: Seq[Expression], _requiredNumPartitions: Int)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val _requiredNumPartitions: Int
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. def createPartitioning(numPartitions: Int): Partitioning

    Creates a default partitioning for this distribution, which can satisfy this distribution while matching the given number of partitions.

    Creates a default partitioning for this distribution, which can satisfy this distribution while matching the given number of partitions.

    Definition Classes
    StatefulOpClusteredDistribution → Distribution
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. val expressions: Seq[Expression]
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def productElementNames: Iterator[String]
    Definition Classes
    Product
  17. val requiredNumPartitions: Option[Int]

    The required number of partitions for this distribution.

    The required number of partitions for this distribution. If it's None, then any number of partitions is allowed for this distribution.

    Definition Classes
    StatefulOpClusteredDistribution → Distribution
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Distribution

Inherited from AnyRef

Inherited from Any

Ungrouped