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

Class MetadataAttribute

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

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable

public final class MetadataAttribute
extends TypedAttribute

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 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 Map<String,org.elasticsearch.xpack.esql.core.expression.MetadataAttribute.MetadataAttributeConfiguration>	ATTRIBUTES_MAP
static final String	DOC
static final String	INDEX
static final String	SCORE
static final String	SIZE
static final String	TIMESERIES
static final String	TIMESTAMP_FIELD
static final String	TSID_FIELD

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
MetadataAttribute(Source source, String name, DataType dataType, boolean searchable)
MetadataAttribute(Source source, String name, DataType dataType, Nullability nullability, NameId id, boolean synthetic, boolean searchable)

Method Summary

Modifier and Type	Method	Description
protected MetadataAttribute	clone(Source source, String qualifier, String name, DataType type, Nullability nullability, NameId id, boolean synthetic)
static NamedExpression	create(Source source, String name)
static DataType	dataType(String name)
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()
static boolean	isScoreAttribute(Expression a)
static boolean	isSupported(String name)
static boolean	isTimeSeriesAttribute(Expression a)
static boolean	isTimeSeriesAttributeName(String name)
protected String	label()
static MetadataAttribute	readFrom(StreamInput in)
boolean	searchable()
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, nodeString, nullable, qualifiedName, qualifier, rawTemporaryName, readQualifier, references, replaceChildren, semanticEquals, semanticHash, toAttribute, toString, withDataType, withId, 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, 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

TIMESTAMP_FIELD

public static final String TIMESTAMP_FIELD

See Also:

• Constant Field Values

TSID_FIELD

public static final String TSID_FIELD

See Also:

• Constant Field Values

SCORE

public static final String SCORE

See Also:

• Constant Field Values

INDEX

public static final String INDEX

See Also:

• Constant Field Values

TIMESERIES

public static final String TIMESERIES

See Also:

• Constant Field Values

SIZE

public static final String SIZE

See Also:

• Constant Field Values

DOC

public static final String DOC

See Also:

• Constant Field Values

ATTRIBUTES_MAP

public static final Map<String,org.elasticsearch.xpack.esql.core.expression.MetadataAttribute.MetadataAttributeConfiguration> ATTRIBUTES_MAP

Constructor Details

MetadataAttribute

public MetadataAttribute(Source source,
 String name,
 DataType dataType,
 Nullability nullability,
 @Nullable
 NameId id,
 boolean synthetic,
 boolean searchable)

MetadataAttribute

public MetadataAttribute(Source source,
 String name,
 DataType dataType,
 boolean searchable)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException

readFrom

public static MetadataAttribute readFrom(StreamInput in)
                                  throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

clone

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

Specified by:

clone 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

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>

searchable

public boolean searchable()

create

public static NamedExpression create(Source source,
 String name)

dataType

public static DataType dataType(String name)

isSupported

public static boolean isSupported(String name)

isScoreAttribute

public static boolean isScoreAttribute(Expression a)

isTimeSeriesAttributeName

public static boolean isTimeSeriesAttributeName(String name)

isTimeSeriesAttribute

public static boolean isTimeSeriesAttribute(Expression a)

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