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

Class InvalidMappedField

java.lang.Object

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

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

org.elasticsearch.xpack.esql.core.type.InvalidMappedField

All Implemented Interfaces:

Writeable

public final class InvalidMappedField
extends TypeConflictedField

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

Representation of a field mapped differently across indices. When SET unmapped_fields="LOAD" this also includes indices missing the field in their mappings, in which case it is treated as DataType.KEYWORD. Used during analysis only; the analyzer's UnionTypesCleanup converts any InvalidMappedFields before the plan leaves the coordinator.

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
InvalidMappedField(String name, Map<String,Set<String>> typesToIndices)
InvalidMappedField(String name, Map<String,Set<String>> typesToIndices, Map<String,EsField> properties)

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.
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.
static InvalidMappedField	potentiallyUnmapped(String name, Map<String,Set<String>> typesToIndices)	An InvalidMappedField is potentially unmapped if at least one index does not contain a mapping for the field, and the user requested we load the values from _source.
Set<DataType>	types()	Source data types observed for this field across all indices.

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, getWriteableName, isAggregatable, isAlias, readFrom, readTimeSeriesFieldType, toString, withDataType, withWidenedSmallNumeric, writeContent, writeTimeSeriesFieldType, writeTo

Methods inherited from class java.lang.Object

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

Constructor Details

InvalidMappedField

public InvalidMappedField(String name,
 Map<String,Set<String>> typesToIndices)

InvalidMappedField

public InvalidMappedField(String name,
 Map<String,Set<String>> typesToIndices,
 Map<String,EsField> properties)

Method Details

potentiallyUnmapped

public static InvalidMappedField potentiallyUnmapped(String name,
 Map<String,Set<String>> typesToIndices)

An InvalidMappedField is potentially unmapped if at least one index does not contain a mapping for the field, and the user requested we load the values from _source. In that case, there is (possibly) an additional type conflict since we treat unmapped fields as DataType.KEYWORD.

hashCode

public int hashCode()

Overrides:

hashCode in class EsField

equals

public boolean equals(Object obj)

Overrides:

equals in class EsField

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

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