org.apache.spark.sql.catalyst.expressions
The computation being performed
The name to be associated with the result of computing child.
A globally unique id used to check if an AttributeReference refers to this alias. Auto-assigned if left blank.
An optional string that can be used to referred to this attribute in a fully qualified way. Consider the examples tableName.name, subQueryAlias.name. tableName and subQueryAlias are possible qualifiers.
Explicit metadata associated with this alias that overwrites child's.
A flag to indicate if this alias is generated by Catalyst
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.
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.
Returns an expression where a best effort attempt has been made to transform this in 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 this in a way
that preserves the result but removes cosmetic variations (case sensitivity, ordering for
commutative operations, etc.) See Canonicalize for more details.
deterministic expressions where this.canonicalized == other.canonicalized will always
evaluate to the same result.
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.
The computation being performed
The computation being performed
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
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 a Seq containing the leaves in this tree.
Returns a Seq containing the leaves in this tree.
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).
Called by unary expressions to generate a code block that returns null if its parent returns
null, and if not null, use f to generate the expression.
Called by unary expressions to generate a code block that returns null if its parent returns
null, and if not null, use f to generate the expression.
As an example, the following does a boolean inversion (i.e. NOT).
defineCodeGen(ctx, ev, c => s"!($c)")
function that accepts a variable name and returns Java code to compute the output.
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: - 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.
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 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 ExprCode with unique terms.
an ExprCode containing the Java source code to generate the given expression
Default behavior of evaluation according to the default nullability of UnaryExpression.
Default behavior of evaluation according to the default nullability of UnaryExpression. If subclass of UnaryExpression override nullable, probably should also override this.
Explicit metadata associated with this alias that overwrites child's.
A globally unique id used to check if an AttributeReference refers to this alias.
A globally unique id used to check if an AttributeReference refers to this alias. Auto-assigned if left blank.
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.
We should never fold named expressions in order to not remove the alias.
We should never fold named expressions in order to not remove the alias.
Runs the given function on this node and then recursively on children.
Runs the given function recursively on children then on this node.
Just a simple passthrough for code generation.
Just a simple passthrough for code generation.
a CodegenContext
ExprCode
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.
Note that this traversal (numbering) order must be the same as getNodeNumbered.
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.
A flag to indicate if this alias is generated by Catalyst
A flag to indicate if this alias is generated by Catalyst
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.
Efficient alternative to productIterator.map(f).toArray.
Efficient alternative to productIterator.map(f).toArray.
Returns the metadata when an expression is a reference to another expression with metadata.
Returns the metadata when an expression is a reference to another expression with metadata.
The name to be associated with the result of computing child.
The name to be associated with the result of computing child.
Returns a copy of this expression with a new exprId.
Returns a copy of this expression with a new exprId.
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.
Called by unary expressions to generate a code block that returns null if its parent returns
null, and if not null, use f to generate the expression.
Called by unary expressions to generate a code block that returns null if its parent returns
null, and if not null, use f to generate the expression.
function that accepts the non-null evaluation result name of child and returns Java code to compute the output.
Called by default eval implementation.
Called by default eval implementation. If subclass of UnaryExpression keep the default nullability, they can override this method to save null-check code. If we need full control of evaluation process, we should override eval.
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).
Args to the constructor that should be copied, but not transformed.
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).
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 dot separated fully qualified name for this attribute.
Returns a dot separated fully qualified name for this attribute. Given that there can be multiple qualifiers, it is possible that there are other possible way to refer to this attribute.
An optional string that can be used to referred to this attribute in a fully qualified way.
An optional string that can be used to referred to this attribute in a fully qualified way. Consider the examples tableName.name, subQueryAlias.name. tableName and subQueryAlias are possible qualifiers.
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).
See Canonicalize for more details.
Returns a hashCode for the calculation performed by this expression.
Returns a hashCode for the calculation performed by this expression. Unlike the standard
hashCode, an attempt has been made to eliminate cosmetic differences.
See Canonicalize for more details.
ONE line description of this node.
ONE line description of this node.
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.
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
ONE line description of this node with more information
ONE line description of this node with more information
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.
Used to assign a new name to a computation. For example the SQL expression "1 + 1 AS a" could be represented as follows: Alias(Add(Literal(1), Literal(1)), "a")()
Note that exprId and qualifiers are in a separate parameter list because we only pattern match on child and name.
The computation being performed
The name to be associated with the result of computing child.
A globally unique id used to check if an AttributeReference refers to this alias. Auto-assigned if left blank.
An optional string that can be used to referred to this attribute in a fully qualified way. Consider the examples tableName.name, subQueryAlias.name. tableName and subQueryAlias are possible qualifiers.
Explicit metadata associated with this alias that overwrites child's.
A flag to indicate if this alias is generated by Catalyst