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

HashPartitioning

case class HashPartitioning(expressions: Seq[Expression], numPartitions: Int) extends Expression with Partitioning with Product with Serializable

Represents a partitioning where rows are split up across partitions based on the hash of expressions. All rows where expressions evaluate to the same values are guaranteed to be in the same partition.

Linear Supertypes
Serializable, Serializable, Product, Equals, Partitioning, Expression, TreeNode[Expression], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HashPartitioning
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Partitioning
  7. Expression
  8. TreeNode
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HashPartitioning(expressions: Seq[Expression], numPartitions: Int)

Type Members

  1. abstract type EvaluatedType

    The narrowest possible type that is produced when this expression is evaluated.

    The narrowest possible type that is produced when this expression is evaluated.

    Definition Classes
    Expression

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. def apply(number: Int): Expression

    Returns the tree node at the specified number.

    Returns the tree node at the specified number. Numbers for each node can be found in the numberedTreeString.

    Definition Classes
    TreeNode
  5. def argString: String

    Returns a string representing the arguments to this node, minus any children

    Returns a string representing the arguments to this node, minus any children

    Definition Classes
    TreeNode
  6. def asCode: String

    Returns a 'scala code' representation of this TreeNode and its children.

    Returns a 'scala code' representation of this TreeNode and its children. Intended for use when debugging where the prettier toString function is obfuscating the actual structure. In the case of 'pure' TreeNodes that only contain primitives and other TreeNodes, the result can be pasted in the REPL to build an equivalent Tree.

    Definition Classes
    TreeNode
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. final def c2(i: Row, e1: Expression, e2: Expression, f: (Ordering[Any], Any, Any) ⇒ Any): Any

    Evaluation helper function for 2 Comparable children expressions.

    Evaluation helper function for 2 Comparable children expressions. Those expressions are supposed to be in the same data type, and the return type should be Integer: Negative value: 1st argument less than 2nd argument Zero: 1st argument equals 2nd argument Positive value: 1st argument greater than 2nd argument

    Either one of the expressions result is null, the evaluation result should be null.

    Attributes
    protected
    Definition Classes
    Expression
    Annotations
    @inline()
  9. def children: Seq[Expression]

    Returns a Seq of the children of this node

    Returns a Seq of the children of this node

    Definition Classes
    HashPartitioningTreeNode
  10. def childrenResolved: Boolean

    Returns true if all the children of this expression have been resolved to a specific schema and false if any still contains any unresolved placeholders.

    Returns true if all the children of this expression have been resolved to a specific schema and false if any still contains any unresolved placeholders.

    Definition Classes
    Expression
  11. def clone(): AnyRef

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

    Returns a Seq containing the result of applying a partial function to all elements in this tree on which the function is defined.

    Returns a Seq containing the result of applying a partial function to all elements in this tree on which the function is defined.

    Definition Classes
    TreeNode
  13. def compatibleWith(other: Partitioning): Boolean

    Returns true iff all distribution guarantees made by this partitioning can also be made for the other specified partitioning.

    Returns true iff all distribution guarantees made by this partitioning can also be made for the other specified partitioning. For example, two HashPartitionings are only compatible if the numPartitions of them is the same.

    Definition Classes
    HashPartitioningPartitioning
  14. def dataType: IntegerType.type

    Returns the DataType of the result of evaluating this expression.

    Returns the DataType of the result of evaluating this expression. It is invalid to query the dataType of an unresolved expression (i.e., when resolved == false).

    Definition Classes
    HashPartitioningExpression
  15. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. def eval(input: Row = null): EvaluatedType

    Returns the result of evaluating this expression on a given input Row

    Returns the result of evaluating this expression on a given input Row

    Definition Classes
    HashPartitioningExpression
  17. val expressions: Seq[Expression]

  18. final def f1(i: Row, e1: Expression, f: (Fractional[Any], Any) ⇒ Any): Any

    Evaluation helper function for 1 Fractional children expression.

    Evaluation helper function for 1 Fractional children expression. if the expression result is null, the evaluation result should be null.

    Attributes
    protected
    Definition Classes
    Expression
    Annotations
    @inline()
  19. final def f2(i: Row, e1: Expression, e2: Expression, f: (Fractional[Any], Any, Any) ⇒ Any): Any

    Evaluation helper function for 2 Fractional children expressions.

    Evaluation helper function for 2 Fractional children expressions. Those expressions are supposed to be in the same data type, and also the return type. Either one of the expressions result is null, the evaluation result should be null.

    Attributes
    protected
    Definition Classes
    Expression
    Annotations
    @inline()
  20. def fastEquals(other: TreeNode[_]): Boolean

    Faster version of equality which short-circuits when two treeNodes are the same instance.

    Faster version of equality which short-circuits when two treeNodes are the same instance. We don't just override Object.Equals, as doing so prevents the scala compiler from from generating case class equals methods

    Definition Classes
    TreeNode
  21. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. def flatMap[A](f: (Expression) ⇒ TraversableOnce[A]): Seq[A]

    Returns a Seq by applying a function to all nodes in this tree and using the elements of the resulting collections.

    Returns a Seq by applying a function to all nodes in this tree and using the elements of the resulting collections.

    Definition Classes
    TreeNode
  23. def foldable: Boolean

    Returns true when an expression is a candidate for static evaluation before the query is executed.

    Returns true when an expression is a candidate for static evaluation before the query is executed.

    The following conditions are used to determine suitability for constant folding:

    Definition Classes
    Expression
  24. def foreach(f: (Expression) ⇒ Unit): Unit

    Runs the given function on this node and then recursively on children.

    Runs the given function on this node and then recursively on children.

    f

    the function to be applied to each node in the tree.

    Definition Classes
    TreeNode
  25. def generateTreeString(depth: Int, builder: StringBuilder): StringBuilder

    Appends the string represent of this node and its children to the given StringBuilder.

    Appends the string represent of this node and its children to the given StringBuilder.

    Attributes
    protected
    Definition Classes
    TreeNode
  26. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  27. def getNodeNumbered(number: MutableInt): Expression

    Attributes
    protected
    Definition Classes
    TreeNode
  28. final def i1(i: Row, e1: Expression, f: (Integral[Any], Any) ⇒ Any): Any

    Evaluation helper function for 1 Integral children expression.

    Evaluation helper function for 1 Integral children expression. if the expression result is null, the evaluation result should be null.

    Attributes
    protected
    Definition Classes
    Expression
    Annotations
    @inline()
  29. final def i2(i: Row, e1: Expression, e2: Expression, f: (Integral[Any], Any, Any) ⇒ Any): Any

    Evaluation helper function for 2 Integral children expressions.

    Evaluation helper function for 2 Integral children expressions. Those expressions are supposed to be in the same data type, and also the return type. Either one of the expressions result is null, the evaluation result should be null.

    Attributes
    protected
    Definition Classes
    Expression
    Annotations
    @inline()
  30. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  31. def makeCopy(newArgs: Array[AnyRef]): HashPartitioning.this.type

    Creates a copy of this type of tree node after a transformation.

    Creates a copy of this type of tree node after a transformation. Must be overridden by child classes that have constructor arguments that are not present in the productIterator.

    newArgs

    the new product arguments.

    Definition Classes
    TreeNode
  32. def map[A](f: (Expression) ⇒ A): Seq[A]

    Returns a Seq containing the result of applying the given function to each node in this tree in a preorder traversal.

    Returns a Seq containing the result of applying the given function to each node in this tree in a preorder traversal.

    f

    the function to be applied.

    Definition Classes
    TreeNode
  33. def mapChildren(f: (Expression) ⇒ Expression): HashPartitioning.this.type

    Returns a copy of this node where f has been applied to all the nodes children.

    Returns a copy of this node where f has been applied to all the nodes children.

    Definition Classes
    TreeNode
  34. def n1(e: Expression, i: Row, f: (Numeric[Any], Any) ⇒ Any): Any

    A set of helper functions that return the correct descendant of scala.math.Numeric[T] type and do any casting necessary of child evaluation.

    A set of helper functions that return the correct descendant of scala.math.Numeric[T] type and do any casting necessary of child evaluation.

    Definition Classes
    Expression
    Annotations
    @inline()
  35. final def n2(i: Row, e1: Expression, e2: Expression, f: (Numeric[Any], Any, Any) ⇒ Any): Any

    Evaluation helper function for 2 Numeric children expressions.

    Evaluation helper function for 2 Numeric children expressions. Those expressions are supposed to be in the same data type, and also the return type. Either one of the expressions result is null, the evaluation result should be null.

    Attributes
    protected
    Definition Classes
    Expression
    Annotations
    @inline()
  36. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  37. def nodeName: String

    Returns the name of this type of TreeNode.

    Returns the name of this type of TreeNode. Defaults to the class name.

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

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

    Definition Classes
    AnyRef
  40. def nullable: Boolean

    Definition Classes
    HashPartitioningExpression
  41. val numPartitions: Int

    Returns the number of partitions that the data is split across

    Returns the number of partitions that the data is split across

    Definition Classes
    HashPartitioningPartitioning
  42. def numberedTreeString: String

    Returns a string representation of the nodes in this tree, where each operator is numbered.

    Returns a string representation of the nodes in this tree, where each operator is numbered. The numbers can be used with apply to easily access specific subtrees.

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

    Args to the constructor that should be copied, but not transformed.

    Args to the constructor that should be copied, but not transformed. These are appended to the transformed args automatically by makeCopy

    returns

    Attributes
    protected
    Definition Classes
    TreeNode
  44. def references: AttributeSet

    Definition Classes
    Expression
  45. lazy val resolved: Boolean

    Returns true if this expression and all its children have been resolved to a specific schema and false if it still contains any unresolved placeholders.

    Returns true if this expression and all its children have been resolved to a specific schema and false if it still contains any unresolved placeholders. Implementations of expressions should override this if the resolution of this type of expression involves more than just the resolution of its children.

    Definition Classes
    Expression
  46. def satisfies(required: Distribution): Boolean

    Returns true iff the guarantees made by this Partitioning are sufficient to satisfy the partitioning scheme mandated by the required Distribution, i.e.

    Returns true iff the guarantees made by this Partitioning are sufficient to satisfy the partitioning scheme mandated by the required Distribution, i.e. the current dataset does not need to be re-partitioned for the required Distribution (it is possible that tuples within a partition need to be reorganized).

    Definition Classes
    HashPartitioningPartitioning
  47. def simpleString: String

    String representation of this node without any children

    String representation of this node without any children

    Definition Classes
    TreeNode
  48. def stringArgs: Iterator[Any]

    The arguments that should be included in the arg string.

    The arguments that should be included in the arg string. Defaults to the productIterator.

    Attributes
    protected
    Definition Classes
    TreeNode
  49. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  50. def toString(): String

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

    Returns a copy of this node where rule has been recursively applied to the tree.

    Returns a copy of this node where rule has been recursively applied to the tree. When rule does not apply to a given node it is left unchanged. Users should not expect a specific directionality. If a specific directionality is needed, transformDown or transformUp should be used.

    rule

    the function use to transform this nodes children

    Definition Classes
    TreeNode
  52. def transformChildrenDown(rule: PartialFunction[Expression, Expression]): HashPartitioning.this.type

    Returns a copy of this node where rule has been recursively applied to all the children of this node.

    Returns a copy of this node where rule has been recursively applied to all the children of this node. When rule does not apply to a given node it is left unchanged.

    rule

    the function used to transform this nodes children

    Definition Classes
    TreeNode
  53. def transformChildrenUp(rule: PartialFunction[Expression, Expression]): HashPartitioning.this.type

    Definition Classes
    TreeNode
  54. def transformDown(rule: PartialFunction[Expression, Expression]): Expression

    Returns a copy of this node where rule has been recursively applied to it and all of its children (pre-order).

    Returns a copy of this node where rule has been recursively applied to it and all of its children (pre-order). When rule does not apply to a given node it is left unchanged.

    rule

    the function used to transform this nodes children

    Definition Classes
    TreeNode
  55. def transformUp(rule: PartialFunction[Expression, Expression]): Expression

    Returns a copy of this node where rule has been recursively applied first to all of its children and then itself (post-order).

    Returns a copy of this node where rule has been recursively applied first to all of its children and then itself (post-order). When rule does not apply to a given node, it is left unchanged.

    rule

    the function use to transform this nodes children

    Definition Classes
    TreeNode
  56. def treeString: String

    Returns a string representation of the nodes in this tree

    Returns a string representation of the nodes in this tree

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. def withNewChildren(newChildren: Seq[Expression]): HashPartitioning.this.type

    Returns a copy of this node with the children replaced.

    Returns a copy of this node with the children replaced. TODO: Validate somewhere (in debug mode?) that children are ordered correctly.

    Definition Classes
    TreeNode

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Partitioning

Inherited from Expression

Inherited from TreeNode[Expression]

Inherited from AnyRef

Inherited from Any

Ungrouped