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

GroupingAnalytics

trait GroupingAnalytics extends UnaryNode

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. GroupingAnalytics
  2. UnaryNode
  3. LogicalPlan
  4. Logging
  5. QueryPlan
  6. TreeNode
  7. Product
  8. Equals
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def aggregations: Seq[NamedExpression]

  2. abstract def canEqual(that: Any): Boolean

    Definition Classes
    Equals
  3. abstract def child: LogicalPlan

    Definition Classes
    UnaryNode
  4. abstract def groupByExprs: Seq[Expression]

  5. abstract def productArity: Int

    Definition Classes
    Product
  6. abstract def productElement(n: Int): Any

    Definition Classes
    Product
  7. abstract def withNewAggs(aggs: Seq[NamedExpression]): GroupingAnalytics

Concrete 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. def analyzed: Boolean

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

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

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

    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

    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]

    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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. def collect[B](pf: PartialFunction[LogicalPlan, 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
  16. def collectFirst[B](pf: PartialFunction[LogicalPlan, B]): Option[B]

    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[_]]

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

    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  20. def expressions: Seq[Expression]

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

    Definition Classes
    TreeNode
  22. def finalize(): Unit

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

    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
  24. def flatMap[A](f: (LogicalPlan) ⇒ 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
  25. def foreach(f: (LogicalPlan) ⇒ 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
  26. def foreachUp(f: (LogicalPlan) ⇒ Unit): Unit

    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
  27. def generateTreeString(depth: Int, lastChildren: Seq[Boolean], 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.

    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
  28. final def getClass(): Class[_]

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

    Attributes
    protected
    Definition Classes
    TreeNode
  30. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  31. def inputSet: AttributeSet

    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
  32. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  33. def isTraceEnabled(): Boolean

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

    Attributes
    protected
    Definition Classes
    TreeNode
  35. def log: Logger

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

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

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

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

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

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

    Attributes
    protected
    Definition Classes
    Logging
  42. def logName: String

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

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

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

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

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

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

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

    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
  51. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  52. 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
  53. final def notify(): Unit

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

    Definition Classes
    AnyRef
  55. 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
  56. val origin: Origin

    Definition Classes
    TreeNode
  57. 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
  58. def output: Seq[Attribute]

    Definition Classes
    GroupingAnalyticsQueryPlan
  59. def outputSet: AttributeSet

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

    Definition Classes
    TreeNode
  61. def printSchema(): Unit

    Prints out the schema in the tree format

    Prints out the schema in the tree format

    Definition Classes
    QueryPlan
  62. def productIterator: Iterator[Any]

    Definition Classes
    Product
  63. def productPrefix: String

    Definition Classes
    Product
  64. def references: AttributeSet

    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
  65. def resolve(nameParts: Seq[String], input: Seq[Attribute], resolver: (String, String) ⇒ Boolean): Option[NamedExpression]

    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
  66. def resolve(nameParts: Seq[String], resolver: (String, String) ⇒ Boolean): Option[NamedExpression]

    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
  67. def resolveChildren(nameParts: Seq[String], resolver: (String, String) ⇒ Boolean): Option[NamedExpression]

    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
  68. def resolveExpressions(r: PartialFunction[Expression, Expression]): LogicalPlan

    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
  69. def resolveOperators(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

    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
  70. def resolveQuoted(name: String, resolver: (String, String) ⇒ Boolean): Option[NamedExpression]

    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.

    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
  71. lazy val resolved: Boolean

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

    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
  73. lazy val schema: StructType

    Definition Classes
    QueryPlan
  74. def schemaString: String

    Returns the output schema in the tree format.

    Returns the output schema in the tree format.

    Definition Classes
    QueryPlan
  75. def simpleString: String

    String representation of this node without any children

    String representation of this node without any children

    Definition Classes
    QueryPlanTreeNode
  76. def statePrefix: String

    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
  77. def statistics: Statistics

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

    Definition Classes
    AnyRef
  80. def toJSON: String

    Definition Classes
    TreeNode
  81. def toString(): String

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

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

    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
  84. def transformChildren(rule: PartialFunction[LogicalPlan, LogicalPlan], nextOperation: (LogicalPlan, PartialFunction[LogicalPlan, LogicalPlan]) ⇒ LogicalPlan): LogicalPlan

    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
  85. def transformDown(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

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

    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
  87. def transformExpressionsDown(rule: PartialFunction[Expression, Expression]): GroupingAnalytics.this.type

    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
  88. def transformExpressionsUp(rule: PartialFunction[Expression, Expression]): GroupingAnalytics.this.type

    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.

    returns

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

    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
  90. 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
  91. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  94. def withNewChildren(newChildren: Seq[LogicalPlan]): LogicalPlan

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