org.apache.spark.sql.catalyst.expressions.aggregate
A helper class for representing an attribute used in merging two aggregation buffers.
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.
Returns a string representing the arguments to this node, minus any children
Returns a string representing the arguments to this node, minus any children
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.
Attributes of fields in bufferSchema.
Attributes of fields in bufferSchema.
An AlgebraicAggregate's bufferSchema is derived from bufferAttributes.
An AlgebraicAggregate's bufferSchema is derived from bufferAttributes.
Checks the input data types, returns TypeCheckResult.success if it's valid,
or returns a TypeCheckResult with an error message if invalid.
Checks the input data types, returns TypeCheckResult.success if it's valid,
or returns a TypeCheckResult with an error message if invalid.
Note: it's not valid to call this method until childrenResolved == true.
Returns a Seq of the children of this node.
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.
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.
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.
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).
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.
Note that this means that an expression should be considered as non-deterministic if: - if it relies on some mutable internal state, or - if it relies on some implicit input that is not part of the children expression list. - if it has non-deterministic child or children.
An example would be SparkPartitionID that relies on the partition id returned by TaskContext.
By default leaf expressions are deterministic as Nil.forall(_.deterministic) returns true.
Returns the result of evaluating this expression on a given input Row
Returns the result of evaluating this expression on a given input Row
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
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).
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.
An aggregate function is not foldable.
An aggregate function is not foldable.
Runs the given function on this node and then recursively on children.
Runs the given function recursively on children then on this node.
Returns an GeneratedExpressionCode, which contains Java source code that can be used to generate the result of evaluating the expression on an input row.
Returns an GeneratedExpressionCode, which contains Java source code that can be used to generate the result of evaluating the expression on an input row.
a CodeGenContext
GeneratedExpressionCode
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.
a CodeGenContext
an GeneratedExpressionCode with unique terms.
Java source code
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.
Initializes its aggregation buffer located in buffer.
Initializes its aggregation buffer located in buffer.
It will use bufferOffset to find the starting point of
its buffer in the given buffer shared with other functions.
The offset of this function's start buffer value in the underlying shared input aggregation buffer.
The offset of this function's start buffer value in the
underlying shared input aggregation buffer. An input aggregation buffer is used
when we merge two aggregation buffers and it is basically the immutable one
(we merge an input aggregation buffer and a mutable aggregation buffer and
then store the new buffer values to the mutable aggregation buffer).
Usually, an input aggregation buffer also contain extra elements like grouping
keys at the beginning. So, mutableBufferOffset and inputBufferOffset are often
different.
For example, we have a grouping expression key, and two aggregate functions
avg(y)avg(x) and . In this shared input aggregation buffer, the position of the first
buffer value of avg(x) will be 1 and the position of the first buffer value of avg(y)
will be 3 (position 0 is used for the value of key).
Expected input types from child expressions.
Expected input types from child expressions. The i-th position in the returned seq indicates the type requirement for the i-th child.
The possible values at each position are: 1. a specific data type, e.g. LongType, StringType. 2. a non-leaf abstract data type, e.g. NumericType, IntegralType, FractionalType.
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.
the new product arguments.
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.
the function to be applied.
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.
Updates its aggregation buffer located in buffer1 by combining intermediate results
in the current buffer and intermediate results from another buffer buffer2.
Updates its aggregation buffer located in buffer1 by combining intermediate results
in the current buffer and intermediate results from another buffer buffer2.
It will use bufferOffset to find the starting point of its buffer in the given buffer1
and buffer2.
The offset of this function's start buffer value in the underlying shared mutable aggregation buffer.
The offset of this function's start buffer value in the
underlying shared mutable aggregation buffer.
For example, we have two aggregate functions avg(x) and avg(y), which share
the same aggregation buffer. In this shared buffer, the position of the first
buffer value of avg(x) will be 0 and the position of the first buffer value of avg(y)
will be 2.
Returns the name of this type of TreeNode.
Returns the name of this type of TreeNode. Defaults to the class name.
Returns a string representation of the nodes in this tree, where each operator is numbered.
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 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.
Returns a user-facing string representation of this expression, i.
Returns a user-facing string representation of this expression, i.e. does not have developer centric debugging information like the expression id.
Returns true if this expression and all its children have been resolved to a specific schema
and input data types checking passed, and false if it still contains any unresolved
placeholders or has data types mismatch.
Returns true if this expression and all its children have been resolved to a specific schema
and input data types checking passed, and false if 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.
Returns true when two expressions will always compute the same result, even if they differ cosmetically (i.
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).
String representation of this node without any children
String representation of this node without any children
The arguments that should be included in the arg string.
The arguments that should be included in the arg string. Defaults to the productIterator.
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.
the function use to transform this nodes children
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.
the function used to transform this nodes children
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.
the function used to transform this nodes children
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.
the function use to transform this nodes children
Returns a string representation of the nodes in this tree
Returns a string representation of the nodes in this tree
Updates its aggregation buffer located in buffer based on the given input.
Updates its aggregation buffer located in buffer based on the given input.
It will use bufferOffset to find the starting point of its buffer in the given buffer
shared with other functions.
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.