All the attributes that are used for this plan.

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.

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 '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 a plan 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, expression id, etc.)

Plans where this.canonicalized == other.canonicalized will always evaluate to the same result.

Plan nodes that require special canonicalization should override doCanonicalize(). They should remove expressions cosmetic variations themselves.

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

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.

Returns a Seq containing the leaves in this tree.

A variant of collect. This method not only apply the given function to all elements in this plan, also considering all the plans in its (nested) subqueries

The active config object within the current scope. See SQLConf.get for more information.

An ExpressionSet that contains invariants about the rows output by this operator. For example, if this set contains the expression a = 2 then that expression is guaranteed to evaluate to true for all rows produced.

Infers a set of isNotNull constraints from null intolerant expressions as well as non-nullable attributes. For e.g., if an expression is of the form (a > 5), this returns a constraint of the form isNotNull(a)

Returns true when the all the expressions in the current node as well as all of its children are deterministic

Defines how the canonicalization should work for the current plan.

Test whether there is TreeNode satisfies the conditions specified in f. The condition is recursively applied to this node and all of its children (pre-order).

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

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

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

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

Appends the string representation of this node and its children to the given Writer.

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.

Default tree pattern for a TreeNode.

Infers an additional set of constraints from a given set of equality constraints. For e.g., if an operator has constraints of the form (a = 5, a = b), this returns an additional constraint of the form b = 5.

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.

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

Invalidates the stats cache. See stats for more information.

Whether this TreeNode and its subtree have been marked as ineffective for the rule with id ruleId.

Returns true if this subtree has data from a streaming data source.

Returns a copy of this node with the children replaced. TODO: Validate somewhere (in debug mode?) that children are ordered correctly.

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.

Returns a Seq containing the result of applying the given function to each node in this tree in a preorder traversal.

Apply a map function to each expression present in this query operator, and return a new query operator based on the mapped expressions.

Efficient alternative to productIterator.map(f).toArray.

Mark that a rule (with id ruleId) is ineffective for this TreeNode and its subtree.

Returns the maximum number of rows that this plan may compute.

Any operator that a Limit can be pushed passed should override this function (e.g., Union). Any operator that can push through a Limit should override this function (e.g., Project).

Returns the maximum number of rows this plan may compute on each partition.

Metadata fields that can be projected from this node. Should be overridden if the plan does not propagate its children's output.

Attributes that are referenced by expressions but not provided by this node's children.

Returns alternative copies of this node where rule has been recursively applied to it and all of its children (pre-order).

Returns alternative copies of this node where rule has 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 Stream to 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 Stream whose elements are also lazily calculated. E.g. multiTransform* calls can be nested with the help of MultiTransform.generateCartesianProduct().

The rule should not apply or can return a one element Seq of original node to indicate that the original node without any transformation is a valid alternative.

The rule can return Seq.empty to indicate that the original node should be pruned. In this case multiTransform() returns an empty Stream.

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 a and b too then we need to explicitly add the original Add(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))

Returns the name of this type of TreeNode. Defaults to the class name. Note that we remove the "Exec" suffix for physical operators here.

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. These are appended to the transformed args automatically by makeCopy

Returns the output ordering that this plan generates, although the semantics differ in logical and physical plans. In the logical plan it means global ordering of the data while in physical it means ordering in each partition.

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

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

Prints out the schema in the tree format

The set of all attributes that are produced by this node.

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.

Refreshes (or invalidates) any metadata/data cached in the plan recursively.

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

Resolves a given schema to concrete Attribute references in this query plan. This function should only be called on analyzed plans since it will throw AnalysisException for unresolved Attributes.

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

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.

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. This function is similar to transform, but skips sub-trees that have already been marked as analyzed. Users should not expect a specific directionality. If a specific directionality is needed, resolveOperatorsUp or resolveOperatorsDown should be used.

Similar to resolveOperatorsUp, but does it top-down.

Similar to resolveOperatorsUpWithPruning, but does it top-down.

Returns a copy of this node where rule has been recursively applied first to all of its children and then itself (post-order, bottom-up). 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.

A variant of transformUpWithNewOutput, which skips touching already analyzed plan.

Returns a copy of this node where rule has been recursively applied first to all of its children and then itself (post-order, bottom-up). 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.

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. This function is similar to transform, but skips sub-trees that have already been marked as analyzed. Users should not expect a specific directionality. If a specific directionality is needed, resolveOperatorsUpWithPruning or resolveOperatorsDownWithPruning should be used.

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

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

Returns true iff other's output is semantically the same, i.e.:

• it contains the same number of Attributes;
• references are the same;
• the order is equal too.

Returns true when the given query plan will return the same results as this query 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.

This function performs a modified version of equality that is tolerant of cosmetic differences like attribute naming and or expression id differences.

Returns the output schema in the tree format.

Returns a hashCode for the calculation performed by this plan. Unlike the standard hashCode, an attempt has been made to eliminate cosmetic differences.

ONE line description of this node.

ONE line description of this node containing the node identifier.

A prefix string used when printing the plan.

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

Returns the estimated statistics for the current logical plan node. Under the hood, this method caches the return value, which is computed based on the configuration passed in the first time. If the configuration changes, the cache can be invalidated by calling invalidateStatsCache().

A cache for the estimated statistics, such that it will only be computed once.

The arguments that should be included in the arg string. Defaults to the productIterator.

All the top-level subqueries of the current plan node. Nested subqueries are not included.

All the subqueries of the current plan node and all its children. Nested subqueries are also included.

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.

Returns the result of running transformExpressions on this node and all its children. Note that this method skips expressions inside subqueries.

Use resolveExpressions() in the analyzer.

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.

In analyzer, use resolveOperatorsDown() instead. If this is used in the analyzer, an exception will be thrown in test mode. It is however OK to call this function within the scope of a resolveOperatorsDown() call.

This method is the top-down (pre-order) counterpart of transformUpWithSubqueries. Returns a copy of this node where the given partial function has been recursively applied first to this node, then this node's subqueries and finally this node's children. When the partial function does not apply to a given node, it is left unchanged.

This method is the top-down (pre-order) counterpart of transformUpWithSubqueries. Returns a copy of this node where the given partial function has been recursively applied first to this node, then this node's subqueries and finally this node's children. When the partial function does not apply to a given node, it is left unchanged.

Runs transformExpressionsDown 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.

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

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

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

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

Runs transformExpressionsDownWithPruning 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.

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.

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.

A variant of transformUp, which takes care of the case that the rule replaces a plan node with a new one that has different output expr IDs, by updating the attribute references in the parent nodes accordingly.

Use resolveOperators() in the analyzer.

Returns a copy of this node where the given partial function has been recursively applied first to the subqueries in this node's children, then this node's children, and finally this node itself (post-order). When the partial function does not apply to a given node, it is left unchanged.

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.

This method is similar to the transform method, but also applies the given partial function also to all the plans in the subqueries of a node. This method is useful when we want to rewrite the whole plan, include its subqueries, in one go.

A BitSet of tree patterns for this TreeNode and its subtree. If this TreeNode and its subtree contains a pattern P, the corresponding bit for P.id is set in this BitSet.

Returns a string representation of the nodes in this tree

The outer plan may have old references and the function below updates the outer references to refer to the new attributes.

This method can be overridden by any child class of QueryPlan to specify a set of constraints based on the given operator's constraint propagation logic. These constraints are then canonicalized and filtered automatically to contain only those attributes that appear in the outputSet.

See Canonicalize for more details.

ONE line description of this node with more information

ONE line description of this node with some suffix information