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

Class FieldAttribute

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

org.elasticsearch.xpack.esql.core.expression.FieldAttribute

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable

Direct Known Subclasses:

TemporalityAttribute, TimeSeriesMetadataAttribute, UnsupportedAttribute

public sealed class FieldAttribute
extends TypedAttribute
permits TemporalityAttribute, TimeSeriesMetadataAttribute, UnsupportedAttribute

Treat this as final - avoid creating new subclasses. This is used extensively throughout the codebase, making new subclasses risky. Consider using a new EsField subclass if needed.

Attribute for an ES field. May actually stand for a field with the same name across different indices (a union), e.g. when index pattern were used in the query: FROM logs-* | KEEP field.

This class offers:

• name - the name of the attribute, but not necessarily of the field.
• The raw EsField representing the field; for parent.child.grandchild this is just grandchild.
• parentName - the full path to the immediate parent of the field, e.g. parent.child (without .grandchild)

To adequately represent e.g. union types, the name of the attribute can be altered because we may have multiple synthetic field attributes that really belong to the same underlying field. For instance, if a multi-typed field is used both as field::string and field::ip, we'll generate 2 field attributes called $$field$converted_to$keyword and $$field$converted_to$ip which still refer to the same underlying index field.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FieldAttribute.FieldName	A field name, as found in the mapping.

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 class org.elasticsearch.xpack.esql.core.tree.Node

Node.NodeStringFormat

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
static final TransportVersion	ESQL_FIELD_ATTRIBUTE_DROP_TYPE
static final TransportVersion	ESQL_TIMESERIES_METADATA_ATTRIBUTE
protected FieldAttribute.FieldName	lazyFieldName

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

SYNTHETIC_ATTRIBUTE_NAME_PREFIX, SYNTHETIC_ATTRIBUTE_NAME_SEPARATOR

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

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
FieldAttribute(Source source, String parentName, String qualifier, String name, EsField field)
FieldAttribute(Source source, String parentName, String qualifier, String name, EsField field, boolean synthetic)
FieldAttribute(Source source, String parentName, String qualifier, String name, EsField field, Nullability nullability, NameId id, boolean synthetic)
FieldAttribute(Source source, String name, EsField field)	Deprecated.

Method Summary

Modifier and Type	Method	Description
Attribute	checkUnresolved()	If the underlying field is an InvalidMappedField (ambiguous type across indices), converts this attribute into an UnsupportedAttribute with a descriptive error message so the analyzer can surface a clear user-facing error.
protected Attribute	clone(Source source, String qualifier, String name, DataType type, Nullability nullability, NameId id, boolean synthetic)
FieldAttribute	exactAttribute()
EsField	field()
FieldAttribute.FieldName	fieldName()	The full name of the field in the index, including all parent fields.
EsField.Exact	getExactInfo()
String	getWriteableName()
protected NodeInfo<? extends Expression>	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	name()	The name of the attribute.
void	nodeString(StringBuilder sb, Node.NodeStringFormat format)	Append this Node's string representation to sb.
String	parentName()
static FieldAttribute	readFrom(StreamInput in)
static TimeSeriesMetadataAttribute	timeSeriesAttribute(Source source)	Creates a TimeSeriesMetadataAttribute representing the MetadataAttribute.TIMESERIES field with no excluded dimensions.
Attribute	withDataType(DataType type)
void	writeTo(StreamOutput out)

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

dataType

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, toString, withId, withLocation, withName, withNullability, withQualifier

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

equals, equals, hashCode, hashCode, id, synthetic

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

canonical, childrenResolved, fold, foldable, propertiesToString, resolved, resolveType, toString, typeResolved

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

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

Methods inherited from class java.lang.Object

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

Field Details

ESQL_FIELD_ATTRIBUTE_DROP_TYPE

public static final TransportVersion ESQL_FIELD_ATTRIBUTE_DROP_TYPE

ESQL_TIMESERIES_METADATA_ATTRIBUTE

public static final TransportVersion ESQL_TIMESERIES_METADATA_ATTRIBUTE

lazyFieldName

protected FieldAttribute.FieldName lazyFieldName

Constructor Details

FieldAttribute

@Deprecated
public FieldAttribute(Source source,
 String name,
 EsField field)

Deprecated.

FieldAttribute

public FieldAttribute(Source source,
 @Nullable
 String parentName,
 @Nullable
 String qualifier,
 String name,
 EsField field,
 boolean synthetic)

FieldAttribute

public FieldAttribute(Source source,
 @Nullable
 String parentName,
 @Nullable
 String qualifier,
 String name,
 EsField field)

FieldAttribute

public FieldAttribute(Source source,
 @Nullable
 String parentName,
 @Nullable
 String qualifier,
 String name,
 EsField field,
 Nullability nullability,
 @Nullable
 NameId id,
 boolean synthetic)

Method Details

timeSeriesAttribute

public static TimeSeriesMetadataAttribute timeSeriesAttribute(Source source)

Creates a TimeSeriesMetadataAttribute representing the MetadataAttribute.TIMESERIES field with no excluded dimensions.

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException

readFrom

public static FieldAttribute readFrom(StreamInput in)
                               throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

info

protected NodeInfo<? extends Expression> 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>

parentName

public String parentName()

fieldName

public FieldAttribute.FieldName fieldName()

The full name of the field in the index, including all parent fields. E.g. parent.subfield.this_field.

checkUnresolved

public Attribute checkUnresolved()

If the underlying field is an InvalidMappedField (ambiguous type across indices), converts this attribute into an UnsupportedAttribute with a descriptive error message so the analyzer can surface a clear user-facing error.

name

public String name()

The name of the attribute. Can deviate from the field name e.g. in case of union types. For the physical field name, use fieldName().

Overrides:

name in class NamedExpression

getExactInfo

public EsField.Exact getExactInfo()

exactAttribute

public FieldAttribute exactAttribute()

clone

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

Specified by:

clone in class Attribute

withDataType

public Attribute withDataType(DataType type)

Overrides:

withDataType in class Attribute

innerHashCode

protected int innerHashCode(boolean ignoreIds)

Overrides:

innerHashCode in class TypedAttribute

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 TypedAttribute

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

field

public EsField field()

nodeString

public void nodeString(StringBuilder sb,
 Node.NodeStringFormat format)

Description copied from class: Node

Append this Node's string representation to sb. This does not include this node's Node.children().

Overrides:

nodeString in class Attribute

Parameters:

sb - target for the string

format - configuration for rendering the string representation