Class

org.apache.spark.sql.catalyst.plans.logical

Cube

Related Doc: package logical

Permalink

case class Cube(groupByExprs: Seq[Expression], child: LogicalPlan, aggregations: Seq[NamedExpression]) extends UnaryNode with GroupingAnalytics with Product with Serializable

Cube is a syntactic sugar for GROUPING SETS, and will be transformed to GroupingSets, and eventually will be transformed to Aggregate(.., Expand) in Analyzer

groupByExprs

The Group By expressions candidates.

child

Child operator

aggregations

The Aggregation expressions, those non selected group by expressions will be considered as constant null if it appears in the expressions

Linear Supertypes
Serializable, Serializable, GroupingAnalytics, UnaryNode, LogicalPlan, Logging, QueryPlan[LogicalPlan], TreeNode[LogicalPlan], Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Cube
  2. Serializable
  3. Serializable
  4. GroupingAnalytics
  5. UnaryNode
  6. LogicalPlan
  7. Logging
  8. QueryPlan
  9. TreeNode
  10. Product
  11. Equals
  12. AnyRef
  13. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Cube(groupByExprs: Seq[Expression], child: LogicalPlan, aggregations: Seq[NamedExpression])

    Permalink

    groupByExprs

    The Group By expressions candidates.

    child

    Child operator

    aggregations

    The Aggregation expressions, those non selected group by expressions will be considered as constant null if it appears in the expressions

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. val aggregations: Seq[NamedExpression]

    Permalink

    The Aggregation expressions, those non selected group by expressions will be considered as constant null if it appears in the expressions

    The Aggregation expressions, those non selected group by expressions will be considered as constant null if it appears in the expressions

    Definition Classes
    CubeGroupingAnalytics
  5. def analyzed: Boolean

    Permalink

    Returns true if this node and its children have already been gone through analysis and verification.

    Returns true if this node and its children have already been gone through analysis and verification. Note that this is only an optimization used to avoid analyzing trees that have already been analyzed, and can be reset by transformations.

    Definition Classes
    LogicalPlan
  6. def apply(number: Int): LogicalPlan

    Permalink

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

    Permalink

    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
  8. def asCode: String

    Permalink

    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
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. val child: LogicalPlan

    Permalink

    Child operator

    Child operator

    Definition Classes
    CubeUnaryNode
  11. def children: Seq[LogicalPlan]

    Permalink

    Returns a Seq of the children of this node.

    Returns a Seq of the children of this node. Children should not change. Immutability required for containsChild optimization

    Definition Classes
    UnaryNodeTreeNode
  12. def childrenResolved: Boolean

    Permalink

    Returns true if all its children of this query plan have been resolved.

    Returns true if all its children of this query plan have been resolved.

    Definition Classes
    LogicalPlan
  13. lazy val cleanArgs: Seq[Any]

    Permalink

    Args that have cleaned such that differences in expression id should not affect equality

    Args that have cleaned such that differences in expression id should not affect equality

    Attributes
    protected
    Definition Classes
    LogicalPlan
  14. def clone(): AnyRef

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

    Permalink

    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
  16. def collectFirst[B](pf: PartialFunction[LogicalPlan, B]): Option[B]

    Permalink

    Finds and returns the first TreeNode of the tree for which the given partial function is defined (pre-order), and applies the partial function to it.

    Finds and returns the first TreeNode of the tree for which the given partial function is defined (pre-order), and applies the partial function to it.

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

    Permalink
    Definition Classes
    TreeNode
  18. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. def expressions: Seq[Expression]

    Permalink

    Returns all of the expressions present in this query plan operator.

    Returns all of the expressions present in this query plan operator.

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

    Permalink

    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 generating case class equals methods

    Definition Classes
    TreeNode
  21. def finalize(): Unit

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

    Permalink

    Find the first TreeNode that satisfies the condition specified by f.

    Find the first TreeNode that satisfies the condition specified by f. The condition is recursively applied to this node and all of its children (pre-order).

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

    Permalink

    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
  24. def foreach(f: (LogicalPlan) ⇒ Unit): Unit

    Permalink

    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 foreachUp(f: (LogicalPlan) ⇒ Unit): Unit

    Permalink

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

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

    f

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

    Definition Classes
    TreeNode
  26. def generateTreeString(depth: Int, lastChildren: Seq[Boolean], builder: StringBuilder): StringBuilder

    Permalink

    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.

    The i-th element in lastChildren indicates whether the ancestor of the current node at depth i + 1 is the last child of its own parent node. The depth of the root node is 0, and lastChildren for the root node should be empty.

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

    Permalink
    Definition Classes
    AnyRef → Any
  28. def getNodeNumbered(number: MutableInt): LogicalPlan

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode
  29. val groupByExprs: Seq[Expression]

    Permalink

    The Group By expressions candidates.

    The Group By expressions candidates.

    Definition Classes
    CubeGroupingAnalytics
  30. def inputSet: AttributeSet

    Permalink

    The set of all attributes that are input to this operator by its children.

    The set of all attributes that are input to this operator by its children.

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode
  34. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  46. def makeCopy(newArgs: Array[AnyRef]): LogicalPlan

    Permalink

    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
  47. def map[A](f: (LogicalPlan) ⇒ A): Seq[A]

    Permalink

    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
  48. def mapChildren(f: (LogicalPlan) ⇒ LogicalPlan): LogicalPlan

    Permalink

    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
  49. def missingInput: AttributeSet

    Permalink

    Attributes that are referenced by expressions but not provided by this nodes children.

    Attributes that are referenced by expressions but not provided by this nodes children. Subclasses should override this method if they produce attributes internally as it is used by assertions designed to prevent the construction of invalid plans.

    Note that virtual columns should be excluded. Currently, we only support the grouping ID virtual column.

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

    Permalink
    Definition Classes
    AnyRef
  51. def nodeName: String

    Permalink

    Returns the name of this type of TreeNode.

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

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

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

    Permalink
    Definition Classes
    AnyRef
  54. def numberedTreeString: String

    Permalink

    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
  55. val origin: Origin

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

    Permalink

    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

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

    Permalink
    Definition Classes
    GroupingAnalyticsQueryPlan
  58. def outputSet: AttributeSet

    Permalink

    Returns the set of attributes that are output by this node.

    Returns the set of attributes that are output by this node.

    Definition Classes
    QueryPlan
  59. def prettyJson: String

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

    Permalink

    Prints out the schema in the tree format

    Prints out the schema in the tree format

    Definition Classes
    QueryPlan
  61. def references: AttributeSet

    Permalink

    All Attributes that appear in expressions from this operator.

    All Attributes that appear in expressions from this operator. Note that this set does not include attributes that are implicitly referenced by being passed through to the output tuple.

    Definition Classes
    QueryPlan
  62. def resolve(nameParts: Seq[String], input: Seq[Attribute], resolver: Resolver): Option[NamedExpression]

    Permalink

    Performs attribute resolution given a name and a sequence of possible attributes.

    Performs attribute resolution given a name and a sequence of possible attributes.

    Attributes
    protected
    Definition Classes
    LogicalPlan
  63. def resolve(nameParts: Seq[String], resolver: Resolver): Option[NamedExpression]

    Permalink

    Optionally resolves the given strings to a NamedExpression based on the output of this LogicalPlan.

    Optionally resolves the given strings to a NamedExpression based on the output of this LogicalPlan. The attribute is expressed as string in the following form: [scope].AttributeName.[nested].[fields]....

    Definition Classes
    LogicalPlan
  64. def resolveChildren(nameParts: Seq[String], resolver: Resolver): Option[NamedExpression]

    Permalink

    Optionally resolves the given strings to a NamedExpression using the input from all child nodes of this LogicalPlan.

    Optionally resolves the given strings to a NamedExpression using the input from all child nodes of this LogicalPlan. The attribute is expressed as as string in the following form: [scope].AttributeName.[nested].[fields]....

    Definition Classes
    LogicalPlan
  65. def resolveExpressions(r: PartialFunction[Expression, Expression]): LogicalPlan

    Permalink

    Recursively transforms the expressions of a tree, skipping nodes that have already been analyzed.

    Recursively transforms the expressions of a tree, skipping nodes that have already been analyzed.

    Definition Classes
    LogicalPlan
  66. def resolveOperators(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

    Permalink

    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. This function is similar to transformUp, but skips sub-trees that have already been marked as analyzed.

    rule

    the function use to transform this nodes children

    Definition Classes
    LogicalPlan
  67. def resolveQuoted(name: String, resolver: Resolver): Option[NamedExpression]

    Permalink

    Given an attribute name, split it to name parts by dot, but don't split the name parts quoted by backticks, for example, ab.cd.efg should be split into two parts "ab.cd" and "efg".

    Given an attribute name, split it to name parts by dot, but don't split the name parts quoted by backticks, for example, ab.cd.efg should be split into two parts "ab.cd" and "efg".

    Definition Classes
    LogicalPlan
  68. lazy val resolved: Boolean

    Permalink

    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 LogicalPlan can override this (e.g. UnresolvedRelation should return false).

    Definition Classes
    GroupingAnalyticsLogicalPlan
  69. def sameResult(plan: LogicalPlan): Boolean

    Permalink

    Returns true when the given logical plan will return the same results as this logical plan.

    Returns true when the given logical plan will return the same results as this logical plan.

    Since its likely undecidable to generally determine if two given plans will produce the same results, it is okay for this function to return false, even if the results are actually the same. Such behavior will not affect correctness, only the application of performance enhancements like caching. However, it is not acceptable to return true if the results could possibly be different.

    By default this function performs a modified version of equality that is tolerant of cosmetic differences like attribute naming and or expression id differences. Logical operators that can do better should override this function.

    Definition Classes
    LogicalPlan
  70. lazy val schema: StructType

    Permalink
    Definition Classes
    QueryPlan
  71. def schemaString: String

    Permalink

    Returns the output schema in the tree format.

    Returns the output schema in the tree format.

    Definition Classes
    QueryPlan
  72. def simpleString: String

    Permalink

    String representation of this node without any children

    String representation of this node without any children

    Definition Classes
    QueryPlanTreeNode
  73. def statePrefix: String

    Permalink

    A prefix string used when printing the plan.

    A prefix string used when printing the plan.

    We use "!" to indicate an invalid plan, and "'" to indicate an unresolved plan.

    Attributes
    protected
    Definition Classes
    LogicalPlanQueryPlan
  74. def statistics: Statistics

    Permalink

    Computes Statistics for this plan.

    Computes Statistics for this plan. The default implementation assumes the output cardinality is the product of of all child plan's cardinality, i.e. applies in the case of cartesian joins.

    LeafNodes must override this.

    Definition Classes
    LogicalPlan
  75. def stringArgs: Iterator[Any]

    Permalink

    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
  76. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  77. def toJSON: String

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

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

    Permalink

    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
  80. def transformAllExpressions(rule: PartialFunction[Expression, Expression]): Cube.this.type

    Permalink

    Returns the result of running transformExpressions on this node and all its children.

    Returns the result of running transformExpressions on this node and all its children.

    Definition Classes
    QueryPlan
  81. def transformChildren(rule: PartialFunction[LogicalPlan, LogicalPlan], nextOperation: (LogicalPlan, PartialFunction[LogicalPlan, LogicalPlan]) ⇒ LogicalPlan): LogicalPlan

    Permalink

    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

    Attributes
    protected
    Definition Classes
    TreeNode
  82. def transformDown(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

    Permalink

    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
  83. def transformExpressions(rule: PartialFunction[Expression, Expression]): Cube.this.type

    Permalink

    Runs transform with rule on all expressions present in this query operator.

    Runs transform with rule on all expressions present in this query operator. Users should not expect a specific directionality. If a specific directionality is needed, transformExpressionsDown or transformExpressionsUp should be used.

    rule

    the rule to be applied to every expression in this operator.

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

    Permalink

    Runs transformDown with rule on all expressions present in this query operator.

    Runs transformDown with rule on all expressions present in this query operator.

    rule

    the rule to be applied to every expression in this operator.

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

    Permalink

    Runs transformUp with rule on all expressions present in this query operator.

    Runs transformUp with rule on all expressions present in this query operator.

    rule

    the rule to be applied to every expression in this operator.

    Definition Classes
    QueryPlan
  86. def transformUp(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

    Permalink

    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
  87. def treeString: String

    Permalink

    Returns a string representation of the nodes in this tree

    Returns a string representation of the nodes in this tree

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  91. def withNewAggs(aggs: Seq[NamedExpression]): GroupingAnalytics

    Permalink
    Definition Classes
    CubeGroupingAnalytics
  92. def withNewChildren(newChildren: Seq[LogicalPlan]): LogicalPlan

    Permalink

    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 GroupingAnalytics

Inherited from UnaryNode

Inherited from LogicalPlan

Inherited from Logging

Inherited from QueryPlan[LogicalPlan]

Inherited from TreeNode[LogicalPlan]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped