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

All Implemented Interfaces:

Writeable

public class InvalidMappedField
extends EsField

Representation of field mapped differently across indices; or being potentially unmapped in some, in which case it is treated as DataType.KEYWORD in the indices where it is unmapped. Used during mapping discovery only. Note that the fields typesToIndices and isPotentiallyUnmapped are not serialized because that information is not required through the cluster, only surviving as long as the Analyser phase of query planning. It is used specifically for the 'union types' and 'unmapped fields' feature in ES|QL.

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	errorMessage()
EsField	getExactField()	Returns the path to the keyword version of this field if this field is text and it has a subfield that is indexed as keyword, throws an exception if such field is not found or the field name itself in all other cases.
EsField.Exact	getExactInfo()	Returns and EsField.Exact object with all the necessary info about the field: If it has an exact underlying field or not and if not an error message why it doesn't
Map<String,Set<String>>	getTypesToIndices()
String	getWriteableName(TransportVersion transportVersion)	This needs to be overridden by subclasses for specific serialization
int	hashCode()
boolean	isPotentiallyUnmapped()
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()
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, getName, getNodeStringName, getProperties, getReader, getTimeSeriesFieldType, isAggregatable, isAlias, readFrom, readTimeSeriesFieldType, toString, writeTimeSeriesFieldType, writeTo

Methods inherited from class java.lang.Object

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

Constructor Details

InvalidMappedField

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

InvalidMappedField

public InvalidMappedField(String name,
 String errorMessage)

InvalidMappedField

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

InvalidMappedField

protected InvalidMappedField(StreamInput in)
                      throws IOException

Throws:

IOException

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.

types

public Set<DataType> types()

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

errorMessage

public String errorMessage()

hashCode

public int hashCode()

Overrides:

hashCode in class EsField

equals

public boolean equals(Object obj)

Overrides:

equals in class EsField

getExactField

public EsField getExactField()

Description copied from class: EsField

Returns the path to the keyword version of this field if this field is text and it has a subfield that is indexed as keyword, throws an exception if such field is not found or the field name itself in all other cases. To avoid the exception EsField.getExactInfo() should be used beforehand, to check if an exact field exists and if not get the errorMessage which explains why is that.

Overrides:

getExactField in class EsField

getExactInfo

public EsField.Exact getExactInfo()

Description copied from class: EsField

Returns and EsField.Exact object with all the necessary info about the field:

• If it has an exact underlying field or not
• and if not an error message why it doesn't

Overrides:

getExactInfo in class EsField

getTypesToIndices

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

isPotentiallyUnmapped

public boolean isPotentiallyUnmapped()