case class DenseRank(children: Seq[Expression]) extends RankLike with Product with Serializable
The DenseRank function computes the rank of a value in a group of values. The result is one plus the previously assigned rank value. Unlike Rank, DenseRank will not produce gaps in the ranking sequence.
This documentation has been based upon similar documentation for the Hive and Presto projects.
- Annotations
- @ExpressionDescription()
- Alphabetic
- By Inheritance
- DenseRank
- RankLike
- AggregateWindowFunction
- WindowFunction
- DeclarativeAggregate
- Serializable
- Serializable
- AggregateFunction
- Expression
- TreeNode
- WithOrigin
- TreePatternBits
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new DenseRank()
- new DenseRank(children: Seq[Expression])
Type Members
-
implicit
class
RichAttribute extends AnyRef
A helper class for representing an attribute used in merging two aggregation buffers.
A helper class for representing an attribute used in merging two aggregation buffers. When merging two buffers,
bufferLeftandbufferRight, we merge buffer values and then update bufferLeft. A RichAttribute of an AttributeReferenceahas two functionsleftandright, which representainbufferLeftandbufferRight, respectively.- Definition Classes
- DeclarativeAggregate
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
aggBufferAttributes: Seq[AttributeReference]
Attributes of fields in aggBufferSchema.
Attributes of fields in aggBufferSchema.
- Definition Classes
- DenseRank → RankLike → AggregateFunction
-
final
def
aggBufferSchema: StructType
An expression-based aggregate's bufferSchema is derived from bufferAttributes.
An expression-based aggregate's bufferSchema is derived from bufferAttributes.
- Definition Classes
- DeclarativeAggregate → AggregateFunction
-
def
apply(number: Int): TreeNode[_]
Returns the tree node at the specified number, used primarily for interactive debugging.
Returns the tree node at the specified number, used primarily for interactive debugging. Numbers for each node can be found in the numberedTreeString.
Note that this cannot return BaseType because logical plan's plan node might return physical plan for innerChildren, e.g. in-memory relation logical plan node has a reference to the physical plan node it is referencing.
- Definition Classes
- TreeNode
-
def
argString(maxFields: Int): 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
-
def
asCode: String
Returns a 'scala code' representation of this
TreeNodeand its children.Returns a 'scala code' representation of this
TreeNodeand its children. Intended for use when debugging where the prettier toString function is obfuscating the actual structure. In the case of 'pure'TreeNodesthat only contain primitives and other TreeNodes, the result can be pasted in the REPL to build an equivalent Tree.- Definition Classes
- TreeNode
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
lazy val
canonicalized: Expression
Returns an expression where a best effort attempt has been made to transform
thisin a way that preserves the result but removes cosmetic variations (case sensitivity, ordering for commutative operations, etc.).Returns an expression where a best effort attempt has been made to transform
thisin a way that preserves the result but removes cosmetic variations (case sensitivity, ordering for commutative operations, etc.).deterministicexpressions wherethis.canonicalized == other.canonicalizedwill always evaluate to the same result.The process of canonicalization is a one pass, bottum-up expression tree computation based on canonicalizing children before canonicalizing the current node. There is one exception though, as adjacent, same class CommutativeExpressions canonicalazion happens in a way that calling
canonicalizedon the root:- Gathers and canonicalizes the non-commutative (or commutative but not same class) child
expressions of the adjacent expressions.
2. Reorder the canonicalized child expressions by their hashcode.
This means that the lazy
cannonicalizedis called and computed only on the root of the adjacent expressions.
- Definition Classes
- Expression
- Gathers and canonicalizes the non-commutative (or commutative but not same class) child
expressions of the adjacent expressions.
2. Reorder the canonicalized child expressions by their hashcode.
This means that the lazy
-
def
checkInputDataTypes(): TypeCheckResult
Checks the input data types, returns
TypeCheckResult.successif it's valid, or returns aTypeCheckResultwith an error message if invalid.Checks the input data types, returns
TypeCheckResult.successif it's valid, or returns aTypeCheckResultwith an error message if invalid. Note: it's not valid to call this method untilchildrenResolved == true.- Definition Classes
- Expression
-
val
children: Seq[Expression]
Returns a Seq of the children of this node.
-
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
-
def
clone(): Expression
- Definition Classes
- TreeNode → AnyRef
-
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
-
def
collectFirst[B](pf: PartialFunction[Expression, 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.
-
def
collectLeaves(): Seq[Expression]
Returns a Seq containing the leaves in this tree.
Returns a Seq containing the leaves in this tree.
- Definition Classes
- TreeNode
-
final
def
containsAllPatterns(patterns: TreePattern*): Boolean
- returns
true if every bit for
patternsis set; false otherwise.
- Definition Classes
- TreePatternBits
-
final
def
containsAnyPattern(patterns: TreePattern*): Boolean
- returns
true if at least one bit for
patternsis set; false otherwise.
- Definition Classes
- TreePatternBits
-
lazy val
containsChild: Set[TreeNode[_]]
- Definition Classes
- TreeNode
-
final
def
containsPattern(t: TreePattern): Boolean
- returns
true if the bit for
tis set; false otherwise.
- Definition Classes
- TreePatternBits
- Annotations
- @inline()
-
def
copyTagsFrom(other: Expression): Unit
- Definition Classes
- TreeNode
-
def
dataType: DataType
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
- AggregateWindowFunction → Expression
-
def
defaultResult: Option[Literal]
Result of the aggregate function when the input is empty.
Result of the aggregate function when the input is empty.
- Definition Classes
- AggregateFunction
-
lazy val
deterministic: Boolean
Returns true when the current expression always return the same result for fixed inputs from children.
Returns true when the current expression always return the same result for fixed inputs from children. The non-deterministic expressions should not change in number and order. They should not be evaluated during the query planning.
Note that this means that an expression should be considered as non-deterministic if: - it relies on some mutable internal state, or - it relies on some implicit input that is not part of the children expression list. - it has non-deterministic child or children. - it assumes the input satisfies some certain condition via the child operator.
An example would be
SparkPartitionIDthat relies on the partition id returned by TaskContext. By default leaf expressions are deterministic as Nil.forall(_.deterministic) returns true.- Definition Classes
- Expression
-
final
def
doGenCode(ctx: CodegenContext, ev: ExprCode): ExprCode
Returns Java source code that can be compiled to evaluate this expression.
Returns Java source code that can be compiled to evaluate this expression. The default behavior is to call the eval method of the expression. Concrete expression implementations should override this to do actual code generation.
- ctx
a CodegenContext
- ev
an ExprCode with unique terms.
- returns
an ExprCode containing the Java source code to generate the given expression
- Attributes
- protected
- Definition Classes
- DeclarativeAggregate → Expression
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
eval(input: InternalRow = null): Any
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
- DeclarativeAggregate → Expression
-
val
evaluateExpression: Expression
An expression which returns the final value for this aggregate function.
An expression which returns the final value for this aggregate function. Its data type should match this expression's dataType.
- Definition Classes
- RankLike → DeclarativeAggregate
-
def
exists(f: (Expression) ⇒ Boolean): Boolean
Test whether there is TreeNode satisfies the conditions specified in
f. -
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
equalsmethods- Definition Classes
- TreeNode
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
find(f: (Expression) ⇒ Boolean): Option[Expression]
Find the first TreeNode that satisfies the condition specified by
f. -
def
flatArguments: Iterator[Any]
- Attributes
- protected
- Definition Classes
- Expression
-
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
-
final
def
foldable: Boolean
An aggregate function is not foldable.
An aggregate function is not foldable.
- Definition Classes
- AggregateFunction → Expression
-
def
foreach(f: (Expression) ⇒ Unit): Unit
Runs the given function on this node and then recursively on children.
-
def
foreachUp(f: (Expression) ⇒ Unit): Unit
Runs the given function recursively on children then on this node.
-
val
frame: WindowFrame
Frame in which the window operator must be executed.
Frame in which the window operator must be executed.
- Definition Classes
- AggregateWindowFunction → WindowFunction
-
def
freshCopyIfContainsStatefulExpression(): Expression
Returns a copy of this expression where all stateful expressions are replaced with fresh uninitialized copies.
Returns a copy of this expression where all stateful expressions are replaced with fresh uninitialized copies. If the expression contains no stateful expressions then the original expression is returned.
- Definition Classes
- Expression
-
def
genCode(ctx: CodegenContext): ExprCode
Returns an ExprCode, that contains the Java source code to generate the result of evaluating the expression on an input row.
Returns an ExprCode, that contains the Java source code to generate the result of evaluating the expression on an input row.
- ctx
a CodegenContext
- returns
ExprCode
- Definition Classes
- Expression
-
def
generateTreeString(depth: Int, lastChildren: ArrayList[Boolean], append: (String) ⇒ Unit, verbose: Boolean, prefix: String = "", addSuffix: Boolean = false, maxFields: Int, printNodeId: Boolean, indent: Int = 0): Unit
Appends the string representation of this node and its children to the given Writer.
Appends the string representation of this node and its children to the given Writer.
The
i-th element inlastChildrenindicates whether the ancestor of the current node at depthi + 1is the last child of its own parent node. The depth of the root node is 0, andlastChildrenfor the root node should be empty.Note that this traversal (numbering) order must be the same as getNodeNumbered.
- Definition Classes
- TreeNode
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getDefaultTreePatternBits: BitSet
Default tree pattern for a TreeNode.
-
def
getTagValue[T](tag: TreeNodeTag[T]): Option[T]
- Definition Classes
- TreeNode
-
def
hashCode(): Int
- Definition Classes
- TreeNode → AnyRef → Any
-
val
increaseRank: If
Increase the rank when the current rank == 0 or when the one of order attributes changes.
Increase the rank when the current rank == 0 or when the one of order attributes changes.
- Attributes
- protected
- Definition Classes
- RankLike
-
val
increaseRowNumber: Expression
- Attributes
- protected
- Definition Classes
- RankLike
-
val
initialValues: Seq[Expression]
Expressions for initializing empty aggregation buffers.
Expressions for initializing empty aggregation buffers.
- Definition Classes
- DenseRank → RankLike → DeclarativeAggregate
-
def
innerChildren: Seq[TreeNode[_]]
All the nodes that should be shown as a inner nested tree of this node.
All the nodes that should be shown as a inner nested tree of this node. For example, this can be used to show sub-queries.
- Definition Classes
- TreeNode
-
lazy val
inputAggBufferAttributes: Seq[AttributeReference]
Attributes of fields in input aggregation buffers (immutable aggregation buffers that are merged with mutable aggregation buffers in the merge() function or merge expressions).
Attributes of fields in input aggregation buffers (immutable aggregation buffers that are merged with mutable aggregation buffers in the merge() function or merge expressions). These attributes are created automatically by cloning the aggBufferAttributes.
- Definition Classes
- DeclarativeAggregate → AggregateFunction
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isRuleIneffective(ruleId: RuleId): Boolean
Whether this TreeNode and its subtree have been marked as ineffective for the rule with id
ruleId.Whether this TreeNode and its subtree have been marked as ineffective for the rule with id
ruleId.- ruleId
the unique id of the rule
- returns
true if the rule has been marked as ineffective; false otherwise. If
ruleIdis UnknownId, it returns false.
- Attributes
- protected
- Definition Classes
- TreeNode
-
def
jsonFields: List[JField]
- Attributes
- protected
- Definition Classes
- TreeNode
-
final
def
legacyWithNewChildren(newChildren: Seq[Expression]): Expression
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.
- Attributes
- protected
- Definition Classes
- TreeNode
-
def
makeCopy(newArgs: Array[AnyRef]): Expression
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
-
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
-
def
mapChildren(f: (Expression) ⇒ Expression): Expression
Returns a copy of this node where
fhas been applied to all the nodes inchildren.Returns a copy of this node where
fhas been applied to all the nodes inchildren.- Definition Classes
- TreeNode
-
def
mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]
Efficient alternative to
productIterator.map(f).toArray.Efficient alternative to
productIterator.map(f).toArray.- Attributes
- protected
- Definition Classes
- TreeNode
-
def
markRuleAsIneffective(ruleId: RuleId): Unit
Mark that a rule (with id
ruleId) is ineffective for this TreeNode and its subtree.Mark that a rule (with id
ruleId) is ineffective for this TreeNode and its subtree.- ruleId
the unique identifier of the rule. If
ruleIdis UnknownId, it is a no-op.
- Attributes
- protected
- Definition Classes
- TreeNode
-
lazy val
mergeExpressions: Nothing
A sequence of expressions for merging two aggregation buffers together.
A sequence of expressions for merging two aggregation buffers together. When defining these expressions, you can use the syntax
attributeName.leftandattributeName.rightto refer to the attributes corresponding to each of the buffers being merged (this magic is enabled by the RichAttribute implicit class).- Definition Classes
- AggregateWindowFunction → DeclarativeAggregate
-
def
multiTransformDown(rule: PartialFunction[Expression, Seq[Expression]]): Stream[Expression]
Returns alternative copies of this node where
rulehas been recursively applied to it and all of its children (pre-order).Returns alternative copies of this node where
rulehas been recursively applied to it and all of its children (pre-order).- rule
a function used to generate alternatives for a node
- returns
the stream of alternatives
- Definition Classes
- TreeNode
-
def
multiTransformDownWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Expression, Seq[Expression]]): Stream[Expression]
Returns alternative copies of this node where
rulehas been recursively applied to it and all of its children (pre-order).Returns alternative copies of this node where
rulehas been recursively applied to it and all of its children (pre-order).As it is very easy to generate enormous number of alternatives when the input tree is huge or when the rule returns many alternatives for many nodes, this function returns the alternatives as a lazy
Streamto be able to limit the number of alternatives generated at the caller side as needed.The purpose of this function to access the returned alternatives by the rule only if they are needed so the rule can return a
Streamwhose elements are also lazily calculated. E.g.multiTransform*calls can be nested with the help ofMultiTransform.generateCartesianProduct().The rule should not apply or can return a one element
Seqof original node to indicate that the original node without any transformation is a valid alternative.The rule can return
Seq.emptyto indicate that the original node should be pruned. In this casemultiTransform()returns an emptyStream.Please consider the following examples of
input.multiTransformDown(rule):We have an input expression:
Add(a, b)1. We have a simple rule:
a=>Seq(1, 2)b=>Seq(10, 20)Add(a, b)=>Seq(11, 12, 21, 22)The output is:
Stream(11, 12, 21, 22)2. In the previous example if we want to generate alternatives of
aandbtoo then we need to explicitly add the originalAdd(a, b)expression to the rule:a=>Seq(1, 2)b=>Seq(10, 20)Add(a, b)=>Seq(11, 12, 21, 22, Add(a, b))The output is:
Stream(11, 12, 21, 22, Add(1, 10), Add(2, 10), Add(1, 20), Add(2, 20))- cond
a Lambda expression to prune tree traversals. If
cond.applyreturns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.- ruleId
is a unique Id for
ruleto prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, ifrule(with idruleId) has been marked as in effective on a TreeNode T, skips processing T and its subtree. Do not pass it if the rule is not purely functional and reads a varying initial state for different invocations.- rule
a function used to generate alternatives for a node
- returns
the stream of alternatives
- Definition Classes
- TreeNode
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
nodeName: String
Returns the name of this type of TreeNode.
Returns the name of this type of TreeNode. Defaults to the class name. Note that we remove the "Exec" suffix for physical operators here.
- Definition Classes
- TreeNode
-
val
nodePatterns: Seq[TreePattern]
- returns
a sequence of tree pattern enums in a TreeNode T. It does not include propagated patterns in the subtree of T.
- Attributes
- protected
- Definition Classes
- TreeNode
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
nullable: Boolean
- Definition Classes
- RankLike → AggregateWindowFunction → Expression
-
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 TreeNode.apply to easily access specific subtrees.
The numbers are based on depth-first traversal of the tree (with innerChildren traversed first before children).
- Definition Classes
- TreeNode
-
val
one: Literal
- Attributes
- protected
- Definition Classes
- RankLike
-
val
orderAttrs: Seq[AttributeReference]
Store the values of the window 'order' expressions.
Store the values of the window 'order' expressions.
- Attributes
- protected
- Definition Classes
- RankLike
-
val
orderEquals: Expression with Serializable
Predicate that detects if the order attributes have changed.
Predicate that detects if the order attributes have changed.
- Attributes
- protected
- Definition Classes
- RankLike
-
val
orderInit: Seq[Literal]
- Attributes
- protected
- Definition Classes
- RankLike
-
val
origin: Origin
- Definition Classes
- TreeNode → WithOrigin
-
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
- Attributes
- protected
- Definition Classes
- TreeNode
-
def
p(number: Int): Expression
Returns the tree node at the specified number, used primarily for interactive debugging.
Returns the tree node at the specified number, used primarily for interactive debugging. Numbers for each node can be found in the numberedTreeString.
This is a variant of apply that returns the node as BaseType (if the type matches).
- Definition Classes
- TreeNode
-
def
prettyJson: String
- Definition Classes
- TreeNode
-
def
prettyName: String
Returns a user-facing string representation of this expression's name.
Returns a user-facing string representation of this expression's name. This should usually match the name of the function in SQL.
- Definition Classes
- DenseRank → Expression
-
val
rank: AttributeReference
- Attributes
- protected
- Definition Classes
- RankLike
-
def
rankSource: Expression
Different RankLike implementations use different source expressions to update their rank value.
-
def
references: AttributeSet
- Definition Classes
- Expression
-
lazy val
resolved: Boolean
Returns
trueif this expression and all its children have been resolved to a specific schema and input data types checking passed, andfalseif it still contains any unresolved placeholders or has data types mismatch.Returns
trueif this expression and all its children have been resolved to a specific schema and input data types checking passed, andfalseif it still contains any unresolved placeholders or has data types mismatch. Implementations of expressions should override this if the resolution of this type of expression involves more than just the resolution of its children and type checking.- Definition Classes
- Expression
-
val
rowNumber: AttributeReference
- Attributes
- protected
- Definition Classes
- RankLike
-
final
def
semanticEquals(other: Expression): Boolean
Returns true when two expressions will always compute the same result, even if they differ cosmetically (i.e.
Returns true when two expressions will always compute the same result, even if they differ cosmetically (i.e. capitalization of names in attributes may be different).
See Canonicalize for more details.
- Definition Classes
- Expression
-
def
semanticHash(): Int
Returns a
hashCodefor the calculation performed by this expression.Returns a
hashCodefor the calculation performed by this expression. Unlike the standardhashCode, an attempt has been made to eliminate cosmetic differences.See Canonicalize for more details.
- Definition Classes
- Expression
-
def
setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
- Definition Classes
- TreeNode
-
def
simpleString(maxFields: Int): String
ONE line description of this node.
ONE line description of this node.
- maxFields
Maximum number of fields that will be converted to strings. Any elements beyond the limit will be dropped.
- Definition Classes
- Expression → TreeNode
-
def
simpleStringWithNodeId(): String
ONE line description of this node containing the node identifier.
ONE line description of this node containing the node identifier.
- Definition Classes
- Expression → TreeNode
-
def
sql: String
Returns SQL representation of this expression.
Returns SQL representation of this expression. For expressions extending NonSQLExpression, this method may return an arbitrary user facing string.
- Definition Classes
- RankLike → Expression
-
def
sql(isDistinct: Boolean): String
- Definition Classes
- AggregateFunction
-
def
stateful: Boolean
Returns true if the expression contains mutable state.
Returns true if the expression contains mutable state.
A stateful expression should never be evaluated multiple times for a single row. This should only be a problem for interpreted execution. This can be prevented by creating fresh copies of the stateful expression before execution. A common example to trigger this issue:
val rand = functions.rand() df.select(rand, rand) // These 2 rand should not share a state.
- Definition Classes
- Expression
-
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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toAggString(isDistinct: Boolean): String
String representation used in explain plans.
String representation used in explain plans.
- Definition Classes
- AggregateFunction
-
def
toAggregateExpression(isDistinct: Boolean, filter: Option[Expression] = None): AggregateExpression
Wraps this AggregateFunction in an AggregateExpression and sets
isDistinctflag of the AggregateExpression to the given value because AggregateExpression is the container of an AggregateFunction, aggregation mode, and the flag indicating if this aggregation is distinct aggregation or not.Wraps this AggregateFunction in an AggregateExpression and sets
isDistinctflag of the AggregateExpression to the given value because AggregateExpression is the container of an AggregateFunction, aggregation mode, and the flag indicating if this aggregation is distinct aggregation or not. An AggregateFunction should not be used without being wrapped in an AggregateExpression.- Definition Classes
- AggregateFunction
-
def
toAggregateExpression(): AggregateExpression
Creates AggregateExpression with
isDistinctflag disabled.Creates AggregateExpression with
isDistinctflag disabled.- Definition Classes
- AggregateFunction
- See also
toAggregateExpression(isDistinct: Boolean)for detailed description
-
def
toJSON: String
- Definition Classes
- TreeNode
-
def
toString(): String
- Definition Classes
- Expression → TreeNode → AnyRef → Any
-
def
transform(rule: PartialFunction[Expression, Expression]): Expression
Returns a copy of this node where
rulehas been recursively applied to the tree.Returns a copy of this node where
rulehas been recursively applied to the tree. Whenruledoes 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 used to transform this nodes children
- Definition Classes
- TreeNode
-
def
transformDown(rule: PartialFunction[Expression, Expression]): Expression
Returns a copy of this node where
rulehas been recursively applied to it and all of its children (pre-order).Returns a copy of this node where
rulehas been recursively applied to it and all of its children (pre-order). Whenruledoes not apply to a given node it is left unchanged.- rule
the function used to transform this nodes children
- Definition Classes
- TreeNode
-
def
transformDownWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Expression, Expression]): Expression
Returns a copy of this node where
rulehas been recursively applied to it and all of its children (pre-order).Returns a copy of this node where
rulehas been recursively applied to it and all of its children (pre-order). Whenruledoes not apply to a given node it is left unchanged.- cond
a Lambda expression to prune tree traversals. If
cond.applyreturns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.- ruleId
is a unique Id for
ruleto prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, ifrule(with idruleId) has been marked as in effective on a TreeNode T, skips processing T and its subtree. Do not pass it if the rule is not purely functional and reads a varying initial state for different invocations.- rule
the function used to transform this nodes children
- Definition Classes
- TreeNode
-
def
transformUp(rule: PartialFunction[Expression, Expression]): Expression
Returns a copy of this node where
rulehas been recursively applied first to all of its children and then itself (post-order).Returns a copy of this node where
rulehas been recursively applied first to all of its children and then itself (post-order). Whenruledoes not apply to a given node, it is left unchanged.- rule
the function used to transform this nodes children
- Definition Classes
- TreeNode
-
def
transformUpWithBeforeAndAfterRuleOnChildren(cond: (Expression) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[(Expression, Expression), Expression]): Expression
Returns a copy of this node where
rulehas been recursively applied first to all of its children and then itself (post-order).Returns a copy of this node where
rulehas been recursively applied first to all of its children and then itself (post-order). Whenruledoes not apply to a given node, it is left unchanged.- cond
a Lambda expression to prune tree traversals. If
cond.applyreturns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.- ruleId
is a unique Id for
ruleto prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, ifrule(with idruleId) has been marked as in effective on a TreeNode T, skips processing T and its subtree. Do not pass it if the rule is not purely functional and reads a varying initial state for different invocations.- rule
the function use to transform this node and its descendant nodes. The function takes a tuple as its input, where the first/second field is the before/after image of applying the rule on the node's children.
- Definition Classes
- TreeNode
-
def
transformUpWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Expression, Expression]): Expression
Returns a copy of this node where
rulehas been recursively applied first to all of its children and then itself (post-order).Returns a copy of this node where
rulehas been recursively applied first to all of its children and then itself (post-order). Whenruledoes not apply to a given node, it is left unchanged.- cond
a Lambda expression to prune tree traversals. If
cond.applyreturns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.- ruleId
is a unique Id for
ruleto prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, ifrule(with idruleId) has been marked as in effective on a TreeNode T, skips processing T and its subtree. Do not pass it if the rule is not purely functional and reads a varying initial state for different invocations.- rule
the function used to transform this nodes children
- Definition Classes
- TreeNode
-
def
transformWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Expression, Expression]): Expression
Returns a copy of this node where
rulehas been recursively applied to the tree.Returns a copy of this node where
rulehas been recursively applied to the tree. Whenruledoes 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.- cond
a Lambda expression to prune tree traversals. If
cond.applyreturns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.- ruleId
is a unique Id for
ruleto prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, ifrule(with idruleId) has been marked as in effective on a TreeNode T, skips processing T and its subtree. Do not pass it if the rule is not purely functional and reads a varying initial state for different invocations.- rule
the function used to transform this nodes children
- Definition Classes
- TreeNode
-
lazy val
treePatternBits: BitSet
A BitSet of tree patterns for this TreeNode and its subtree.
A BitSet of tree patterns for this TreeNode and its subtree. If this TreeNode and its subtree contains a pattern
P, the corresponding bit forP.idis set in this BitSet.- Definition Classes
- TreeNode → TreePatternBits
-
def
treeString(append: (String) ⇒ Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
- Definition Classes
- TreeNode
-
final
def
treeString(verbose: Boolean, addSuffix: Boolean = false, maxFields: Int = SQLConf.get.maxToStringFields, printOperatorId: Boolean = false): String
- Definition Classes
- TreeNode
-
final
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
-
def
typeSuffix: String
- Attributes
- protected
- Definition Classes
- Expression
-
def
unsetTagValue[T](tag: TreeNodeTag[T]): Unit
- Definition Classes
- TreeNode
-
val
updateExpressions: Seq[Expression]
Expressions for updating the mutable aggregation buffer based on an input row.
Expressions for updating the mutable aggregation buffer based on an input row.
- Definition Classes
- DenseRank → RankLike → DeclarativeAggregate
-
final
def
verboseString(maxFields: Int): String
ONE line description of this node with more information
ONE line description of this node with more information
- Definition Classes
- Expression → TreeNode
-
def
verboseStringWithSuffix(maxFields: Int): String
ONE line description of this node with some suffix information
ONE line description of this node with some suffix information
- Definition Classes
- TreeNode
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
withCanonicalizedChildren: Expression
The default process of canonicalization.
The default process of canonicalization. It is a one pass, bottum-up expression tree computation based oncanonicalizing children before canonicalizing the current node.
- Attributes
- protected
- Definition Classes
- Expression
-
final
def
withNewChildren(newChildren: Seq[Expression]): Expression
- Definition Classes
- TreeNode
- def withNewChildrenInternal(newChildren: IndexedSeq[Expression]): DenseRank
- def withOrder(order: Seq[Expression]): DenseRank
-
val
zero: Literal
- Attributes
- protected
- Definition Classes
- RankLike