Package org.elasticsearch.xpack.esql.core.expression

Class UnresolvedAttribute

java.lang.Object

org.elasticsearch.xpack.esql.core.tree.Node<Expression>

org.elasticsearch.xpack.esql.core.expression.Expression

org.elasticsearch.xpack.esql.core.expression.NamedExpression

org.elasticsearch.xpack.esql.core.expression.Attribute

org.elasticsearch.xpack.esql.core.expression.UnresolvedAttribute

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, Unresolvable

Direct Known Subclasses:

UnresolvedTimestamp

public class UnresolvedAttribute
extends Attribute
implements Unresolvable

An unresolved attribute. We build these while walking the syntax tree and then resolve them into other Attribute subclasses during analysis. Aliases whose types are not yet resolved also return UnresolvedAttributes when calling Alias.toAttribute().

Note that the NamedExpression.id() is respected in NamedExpression.equals(Object). Two unresolved attributes with the same name but different NameId can occur e.g. when resolving EVAL x = 2*x, y = 3*x. In the first expression, x is referring to an upstream attribute, while in the second expression it is referring to the alias defined in the first expression. This allows us to distinguish the attributes generated by the EVAL from attributes referenced by it.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Attribute

Attribute.IdIgnoringWrapper

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

Expression.TypeResolution

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected final Object	resolutionMetadata
protected final String	unresolvedMsg

Fields inherited from class org.elasticsearch.xpack.esql.core.expression.Attribute

SYNTHETIC_ATTRIBUTE_NAME_PREFIX

Fields inherited from class org.elasticsearch.xpack.esql.core.tree.Node

TO_STRING_MAX_WIDTH

Fields inherited from interface org.elasticsearch.xpack.esql.core.capabilities.Unresolvable

UNRESOLVED_PREFIX

Constructor Summary

Constructors

Constructor	Description
UnresolvedAttribute(Source source, String name)
UnresolvedAttribute(Source source, String name, String unresolvedMessage)
UnresolvedAttribute(Source source, String qualifier, String name, String unresolvedMessage)
UnresolvedAttribute(Source source, String qualifier, String name, NameId id, String unresolvedMessage, Object resolutionMetadata)
UnresolvedAttribute(Source source, String name, NameId id, String unresolvedMessage, Object resolutionMetadata)

Method Summary

Modifier and Type	Method	Description
protected Attribute	clone(Source source, String qualifier, String name, DataType dataType, Nullability nullability, NameId id, boolean synthetic)
boolean	customMessage()
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
static String	errorMessage(String name, List<String> potentialMatches)
String	getWriteableName()
protected NodeInfo<? extends UnresolvedAttribute>	info()	Normally, you want to use one of the static create methods to implement this.
protected boolean	innerEquals(Object o, boolean ignoreIds)	The actual equality check, after shortcutting this == o and class checks.
protected int	innerHashCode(boolean ignoreIds)
boolean	isDimension()
boolean	isMetric()
protected String	label()
String	nodeString()
Object	resolutionMetadata()
boolean	resolved()
protected Expression.TypeResolution	resolveType()	The implementation of Expression.typeResolved(), which is just a caching wrapper around this method.
String	toString()
String	unresolvedMessage()	NOTE: Any non-null return value from this method indicates that the item in question could not be resolved.
UnresolvedAttribute	withId(NameId id)
UnresolvedAttribute	withUnresolvedMessage(String unresolvedMessage)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Attribute

canonicalize, checkAndSerializeQualifier, dataTypeEquals, ignoreId, nullable, qualifiedName, qualifier, rawTemporaryName, readQualifier, references, replaceChildren, semanticEquals, semanticHash, toAttribute, withDataType, withLocation, withName, withNullability, withQualifier

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.NamedExpression

equals, equals, hashCode, hashCode, id, name, synthetic

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

canonical, childrenResolved, fold, foldable, propertiesToString, typeResolved

Methods inherited from class org.elasticsearch.xpack.esql.core.tree.Node

anyMatch, children, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, replaceChildrenSameSize, source, sourceLocation, sourceText, transformChildren, transformDown, transformDown, transformDown, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUp

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

unresolvedMsg

protected final String unresolvedMsg

resolutionMetadata

protected final Object resolutionMetadata

Constructor Details

UnresolvedAttribute

public UnresolvedAttribute(Source source,
 String name)

UnresolvedAttribute

public UnresolvedAttribute(Source source,
 String name,
 @Nullable
 String unresolvedMessage)

UnresolvedAttribute

public UnresolvedAttribute(Source source,
 @Nullable
 String qualifier,
 String name,
 @Nullable
 String unresolvedMessage)

UnresolvedAttribute

public UnresolvedAttribute(Source source,
 String name,
 @Nullable
 NameId id,
 @Nullable
 String unresolvedMessage,
 Object resolutionMetadata)

UnresolvedAttribute

public UnresolvedAttribute(Source source,
 @Nullable
 String qualifier,
 String name,
 @Nullable
 NameId id,
 @Nullable
 String unresolvedMessage,
 Object resolutionMetadata)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

info

protected NodeInfo<? extends UnresolvedAttribute> info()

Description copied from class: Node

Normally, you want to use one of the static create methods to implement this.

For QueryPlans, it is very important that the properties contain all of the expressions and references relevant to this node, and that all the properties are used in the provided constructor; otherwise query plan transformations like QueryPlan#transformExpressionsOnly(Function) will not have an effect.

Specified by:

info in class Node<Expression>

resolutionMetadata

public Object resolutionMetadata()

customMessage

public boolean customMessage()

resolved

public boolean resolved()

Specified by:

resolved in interface Resolvable

Specified by:

resolved in interface Unresolvable

Overrides:

resolved in class Expression

clone

protected Attribute clone(Source source,
 String qualifier,
 String name,
 DataType dataType,
 Nullability nullability,
 NameId id,
 boolean synthetic)

Specified by:

clone in class Attribute

withId

public UnresolvedAttribute withId(NameId id)

Overrides:

withId in class Attribute

withUnresolvedMessage

public UnresolvedAttribute withUnresolvedMessage(String unresolvedMessage)

resolveType

protected Expression.TypeResolution resolveType()

Description copied from class: Expression

The implementation of Expression.typeResolved(), which is just a caching wrapper around this method. See it's javadoc for what this method should return.

Implementations will rarely interact with the Expression.TypeResolution class directly, instead usually calling the utility methods on TypeResolutions.

Implementations should fail if Expression.childrenResolved() returns false.

Overrides:

resolveType in class Expression

dataType

public DataType dataType()

Description copied from class: Expression

The DataType returned by executing the tree rooted at this expression. If Expression.typeResolved() returns an error then the behavior of this method is undefined. It may return a valid type. Or it may throw an exception. Or it may return a totally nonsensical type.

Specified by:

dataType in class Expression

toString

public String toString()

Overrides:

toString in class Attribute

label

protected String label()

Specified by:

label in class Attribute

isDimension

public boolean isDimension()

Specified by:

isDimension in class Attribute

Returns:

true if the attribute represents a TSDB dimension type

isMetric

public boolean isMetric()

Specified by:

isMetric in class Attribute

Returns:

true if the attribute represents a TSDB metric type

nodeString

public String nodeString()

Overrides:

nodeString in class Attribute

unresolvedMessage

public String unresolvedMessage()

Description copied from interface: Unresolvable

NOTE: Any non-null return value from this method indicates that the item in question could not be resolved.

Specified by:

unresolvedMessage in interface Unresolvable

errorMessage

public static String errorMessage(String name,
 List<String> potentialMatches)

innerHashCode

protected int innerHashCode(boolean ignoreIds)

Overrides:

innerHashCode in class Attribute

innerEquals

protected boolean innerEquals(Object o,
 boolean ignoreIds)

Description copied from class: NamedExpression

The actual equality check, after shortcutting this == o and class checks.

Overrides:

innerEquals in class Attribute