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

Class PotentiallyUnmappedSingleTypeEsField

java.lang.Object

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

org.elasticsearch.xpack.esql.core.type.TypeConflictedField

org.elasticsearch.xpack.esql.core.type.PotentiallyUnmappedSingleTypeEsField

All Implemented Interfaces:

Writeable

public final class PotentiallyUnmappedSingleTypeEsField
extends TypeConflictedField

A variant of PotentiallyUnmappedKeywordEsField that is mapped to exactly one, non-keyword type where it is mapped, and unmapped in other indices. Its EsField.getDataType() is that mapped type (widened for small numerics), because reporting DataType.UNSUPPORTED (as a bare TypeConflictedField does) breaks renames and groupings that read the type before this field is resolved. It retains the original, unwidened mapped EsField (with its properties) to fall back to.

If an implicit cast from DataType.KEYWORD to the mapped type exists, it is auto-cast to that type. Otherwise it behaves exactly as without UNMAPPED_FIELDS="LOAD" (mapped type where mapped, null where unmapped), unless an explicit cast accepting KEYWORD is applied directly to the field, which loads the unmapped rows from _source.

We treat this as a TypeConflictedField because it must still be resolved: via an implicit cast, an explicit cast, or fallback.

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

Constructor	Description
PotentiallyUnmappedSingleTypeEsField(EsField mappedField, Set<String> mappedIndices)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Map<String,Set<String>>	getTypesToIndices()	Per-source-type indices in which the field appears with that type.
String	getWriteableName(TransportVersion transportVersion)	This needs to be overridden by subclasses for specific serialization
int	hashCode()
boolean	isPotentiallyUnmapped()	Whether the field is unmapped in at least one index, in which case it's treated as DataType.KEYWORD where it is unmapped.
EsField	mappedField()
Set<DataType>	types()	Source data types observed for this field across all indices.
void	writeContent(StreamOutput out)	This needs to be overridden by subclasses for specific serialization

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

errorMessage, getExactField, getExactInfo, isSingleTypePotentiallyUnmapped, singleMappedType, singleMappedTypeWidened

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

getDataType, getName, getNodeStringName, getProperties, getReader, getTimeSeriesFieldType, isAggregatable, isAlias, readFrom, readTimeSeriesFieldType, toString, withDataType, withWidenedSmallNumeric, writeTimeSeriesFieldType, writeTo

Methods inherited from class java.lang.Object

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

Constructor Details

PotentiallyUnmappedSingleTypeEsField

public PotentiallyUnmappedSingleTypeEsField(EsField mappedField,
 Set<String> mappedIndices)

Method Details

mappedField

public EsField mappedField()

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

types

public Set<DataType> types()

Description copied from class: TypeConflictedField

Source data types observed for this field across all indices.

Specified by:

types in class TypeConflictedField

getTypesToIndices

public Map<String,Set<String>> getTypesToIndices()

Description copied from class: TypeConflictedField

Per-source-type indices in which the field appears with that type. Note that CompactInvalidMappedField caps each set and may include the "..." sentinel; callers that need a complete index list should use InvalidMappedField instead.

Specified by:

getTypesToIndices in class TypeConflictedField

isPotentiallyUnmapped

public boolean isPotentiallyUnmapped()

Description copied from class: TypeConflictedField

Whether the field is unmapped in at least one index, in which case it's treated as DataType.KEYWORD where it is unmapped.

Specified by:

isPotentiallyUnmapped in class TypeConflictedField

hashCode

public int hashCode()

Overrides:

hashCode in class EsField

equals

public boolean equals(Object obj)

Overrides:

equals in class EsField