Package org.elasticsearch.xpack.esql.core.type

Class MultiTypeEsField

java.lang.Object

org.elasticsearch.xpack.esql.core.type.EsField

org.elasticsearch.xpack.esql.core.type.UnionTypeEsField

org.elasticsearch.xpack.esql.core.type.MultiTypeEsField

All Implemented Interfaces:

Writeable

public final class MultiTypeEsField
extends UnionTypeEsField

N.B.: This class exists only as a backward-compatible version of CompactMultiTypeEsField.

During IndexResolution it can occur that the same field is mapped to different types in different indices. An InvalidMappedField holds that information and allows for later resolution of the field to a single type in ResolveUnionTypes. If the plan contains a converted field attribute with mapping conflict, like EVAL x = x::long, this conversion is fused into the FieldAttribute and represented by an instance of this class instead of the InvalidMappedField. This class is sent to the data nodes to inform them that they have to convert the type directly during field extraction.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.type.EsField

EsField.Exact, EsField.TimeSeriesFieldType

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

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

Constructor Summary

Constructors

Modifier	Constructor	Description
	MultiTypeEsField(String name, DataType dataType, boolean aggregatable, Map<String,Expression> indexToConversionExpressions, EsField.TimeSeriesFieldType timeSeriesFieldType, Expression potentiallyUnmappedExpression)
protected	MultiTypeEsField(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Expression	getConversionExpressionForIndex(String indexName)
Collection<Expression>	getConversionExpressions()
Map<String,Expression>	getIndexToConversionExpressions()
String	getNodeStringName()
Expression	getPotentiallyUnmappedExpression()
Expression	getUnmappedConversionExpression()	Conversion expression to apply when the field is unmapped in the index (treating it as DataType.KEYWORD) or null if there is no such conversion (i.e., unmapped indices should produce null).
String	getWriteableName(TransportVersion transportVersion)	This needs to be overridden by subclasses for specific serialization
int	hashCode()
static MultiTypeEsField	resolveFrom(TypeConflictedField typeConflictedField, Map<String,Expression> typesToConversionExpressions)
UnionTypeEsField	rewrapWithCast(Expression convertExpression)	Wraps an existing union-type field's per-(index|type) conversions with another conversion expression on top, so the composite expression first does the original cast then the additional cast.
String	toString()
UnionTypeEsField	withPotentiallyUnmappedExpression(Expression potentiallyUnmappedExpression)	Returns a copy of this field with the given unmapped conversion expression.
void	writeContent(StreamOutput out)	This needs to be overridden by subclasses for specific serialization

Methods inherited from class org.elasticsearch.xpack.esql.core.type.EsField

getDataType, getExactField, getExactInfo, getName, getProperties, getReader, getTimeSeriesFieldType, isAggregatable, isAlias, readFrom, readTimeSeriesFieldType, withDataType, withWidenedSmallNumeric, writeTimeSeriesFieldType, writeTo

Methods inherited from class java.lang.Object

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

Constructor Details

MultiTypeEsField

public MultiTypeEsField(String name,
 DataType dataType,
 boolean aggregatable,
 Map<String,Expression> indexToConversionExpressions,
 EsField.TimeSeriesFieldType timeSeriesFieldType,
 @Nullable
 Expression potentiallyUnmappedExpression)

MultiTypeEsField

protected MultiTypeEsField(StreamInput in)
                    throws IOException

Throws:

IOException

Method Details

writeContent

public void writeContent(StreamOutput out)
                  throws IOException

Description copied from class: EsField

This needs to be overridden by subclasses for specific serialization

Overrides:

writeContent in class EsField

Throws:

IOException

getWriteableName

public String getWriteableName(TransportVersion transportVersion)

Description copied from class: EsField

This needs to be overridden by subclasses for specific serialization

Overrides:

getWriteableName in class EsField

getNodeStringName

public String getNodeStringName()

Overrides:

getNodeStringName in class EsField

getPotentiallyUnmappedExpression

@Nullable
public Expression getPotentiallyUnmappedExpression()

getUnmappedConversionExpression

@Nullable
public Expression getUnmappedConversionExpression()

Description copied from class: UnionTypeEsField

Conversion expression to apply when the field is unmapped in the index (treating it as DataType.KEYWORD) or null if there is no such conversion (i.e., unmapped indices should produce null).

Specified by:

getUnmappedConversionExpression in class UnionTypeEsField

getIndexToConversionExpressions

public Map<String,Expression> getIndexToConversionExpressions()

getConversionExpressions

public Collection<Expression> getConversionExpressions()

Specified by:

getConversionExpressions in class UnionTypeEsField

rewrapWithCast

public UnionTypeEsField rewrapWithCast(Expression convertExpression)

Description copied from class: UnionTypeEsField

Wraps an existing union-type field's per-(index|type) conversions with another conversion expression on top, so the composite expression first does the original cast then the additional cast.

Specified by:

rewrapWithCast in class UnionTypeEsField

getConversionExpressionForIndex

@Nullable
public Expression getConversionExpressionForIndex(String indexName)

withPotentiallyUnmappedExpression

public UnionTypeEsField withPotentiallyUnmappedExpression(Expression potentiallyUnmappedExpression)

Description copied from class: UnionTypeEsField

Returns a copy of this field with the given unmapped conversion expression.

Specified by:

withPotentiallyUnmappedExpression in class UnionTypeEsField

resolveFrom

public static MultiTypeEsField resolveFrom(TypeConflictedField typeConflictedField,
 Map<String,Expression> typesToConversionExpressions)

equals

public boolean equals(Object obj)

Overrides:

equals in class EsField

hashCode

public int hashCode()

Overrides:

hashCode in class EsField

toString

public String toString()

Overrides:

toString in class EsField