case class AttributeReference(name: String, dataType: DataType, nullable: Boolean = true, metadata: Metadata = Metadata.empty)(exprId: ExprId = NamedExpression.newExprId, qualifier: Seq[String] = Seq.empty[String]) extends Attribute with Unevaluable with Product with Serializable
A reference to an attribute produced by another operator in the tree.
- name
The name of this attribute, should only be used during analysis or for debugging.
- dataType
The DataType of this attribute.
- nullable
True if null is a valid value for this attribute.
- metadata
The metadata of this attribute.
- exprId
A globally unique id used to check if different AttributeReferences refer to the same attribute.
- qualifier
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.
- Alphabetic
- By Inheritance
- AttributeReference
- Serializable
- Serializable
- Unevaluable
- Attribute
- NullIntolerant
- NamedExpression
- LeafExpression
- Expression
- TreeNode
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
AttributeReference(name: String, dataType: DataType, nullable: Boolean = true, metadata: Metadata = Metadata.empty)(exprId: ExprId = NamedExpression.newExprId, qualifier: Seq[String] = Seq.empty[String])
- name
The name of this attribute, should only be used during analysis or for debugging.
- dataType
The DataType of this attribute.
- nullable
True if null is a valid value for this attribute.
- metadata
The metadata of this attribute.
- exprId
A globally unique id used to check if different AttributeReferences refer to the same attribute.
- qualifier
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.
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
-
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.) See Canonicalize for more details.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.) See Canonicalize for more details.deterministicexpressions wherethis.canonicalized == other.canonicalizedwill always evaluate to the same result.- Definition Classes
- Expression
-
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
-
final
def
children: Seq[Expression]
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
- LeafExpression → TreeNode
-
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
-
lazy val
containsChild: Set[TreeNode[_]]
- Definition Classes
- TreeNode
-
def
copyTagsFrom(other: Expression): Unit
- Attributes
- protected
- Definition Classes
- TreeNode
-
val
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
- AttributeReference → Expression
-
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
- Unevaluable → Expression
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(other: Any): Boolean
- Definition Classes
- AttributeReference → Equals → AnyRef → Any
-
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
- Unevaluable → Expression
-
val
exprId: ExprId
- Definition Classes
- AttributeReference → NamedExpression
-
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
-
def
foldable: Boolean
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.
- Definition Classes
- NamedExpression → 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.
-
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: Seq[Boolean], append: (String) ⇒ Unit, verbose: Boolean, prefix: String = "", addSuffix: Boolean = false, maxFields: Int, printNodeId: Boolean): 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
getTagValue[T](tag: TreeNodeTag[T]): Option[T]
- Definition Classes
- TreeNode
-
def
hashCode(): Int
- Definition Classes
- AttributeReference → TreeNode → AnyRef → Any
-
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
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
jsonFields: List[JField]
- 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
-
val
metadata: Metadata
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.
- Definition Classes
- AttributeReference → NamedExpression
-
val
name: String
- Definition Classes
- AttributeReference → NamedExpression
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
newInstance(): AttributeReference
Returns a copy of this expression with a new
exprId.Returns a copy of this expression with a new
exprId.- Definition Classes
- AttributeReference → Attribute → NamedExpression
-
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
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
val
nullable: Boolean
- Definition Classes
- AttributeReference → 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
origin: Origin
- Definition Classes
- TreeNode
-
final
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
- AttributeReference → 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
- Expression
-
def
qualifiedName: String
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.
- Definition Classes
- NamedExpression
-
val
qualifier: Seq[String]
Optional qualifier for the expression.
Optional qualifier for the expression. Qualifier can also contain the fully qualified information, for e.g, Sequence of string containing the database and the table name
For now, since we do not allow using original table name to qualify a column name once the table is aliased, this can only be:
1. Empty Seq: when an attribute doesn't have a qualifier, e.g. top level attributes aliased in the SELECT clause, or column from a LocalRelation. 2. Seq with a Single element: either the table name or the alias name of the table. 3. Seq with 2 elements: database name and table name
- Definition Classes
- AttributeReference → NamedExpression
-
lazy val
references: AttributeSet
- Definition Classes
- Attribute → Expression
- Annotations
- @transient()
-
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
-
def
sameRef(other: AttributeReference): Boolean
Returns true iff the expression id is the same for both attributes.
-
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
- AttributeReference → 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
- AttributeReference → 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
- AttributeReference → 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
- AttributeReference → 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
toAttribute: Attribute
- Definition Classes
- Attribute → NamedExpression
-
def
toJSON: String
- Definition Classes
- TreeNode
-
def
toString(): String
- Definition Classes
- AttributeReference → 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 use 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
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 use to transform this nodes children
- Definition Classes
- TreeNode
-
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
- NamedExpression
-
def
unsetTagValue[T](tag: TreeNodeTag[T]): Unit
- Definition Classes
- TreeNode
-
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()
-
def
withExprId(newExprId: ExprId): AttributeReference
- Definition Classes
- AttributeReference → Attribute
-
def
withMetadata(newMetadata: Metadata): AttributeReference
- Definition Classes
- AttributeReference → Attribute
-
def
withName(newName: String): AttributeReference
- Definition Classes
- AttributeReference → Attribute
-
def
withNewChildren(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.
- Definition Classes
- TreeNode
-
def
withNullability(newNullability: Boolean): AttributeReference
Returns a copy of this AttributeReference with changed nullability.
Returns a copy of this AttributeReference with changed nullability.
- Definition Classes
- AttributeReference → Attribute
-
def
withQualifier(newQualifier: Seq[String]): AttributeReference
Returns a copy of this AttributeReference with new qualifier.
Returns a copy of this AttributeReference with new qualifier.
- Definition Classes
- AttributeReference → Attribute