Package org.elasticsearch.xpack.esql.session

Class IndexResolver

java.lang.Object

org.elasticsearch.xpack.esql.session.IndexResolver

public class IndexResolver
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	IndexResolver.FieldsInfo	Information for resolving a field.
static interface	IndexResolver.OriginalIndexExtractor

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	ALL_FIELDS
static final IndicesOptions	DEFAULT_OPTIONS
static final IndexResolver.OriginalIndexExtractor	DO_NOT_GROUP
static final Set<String>	INDEX_METADATA_FIELD
static final String	UNMAPPED

Constructor Summary

Constructors

Constructor	Description
IndexResolver(Client client, BooleanSupplier flattenedDataTypeEnabled)

Method Summary

Modifier and Type	Method	Description
static IndexResolution	mergedMappings(String indexPattern, boolean allowEmpty, IndexResolver.FieldsInfo fieldsInfo, boolean trackUnmappedFieldIndices, IndexResolver.OriginalIndexExtractor originalIndexExtractor)
void	resolveFlatIndicesVersioned(boolean lenient, String indexPattern, String projectRouting, Set<String> fieldNames, QueryBuilder requestFilter, boolean includeAllDimensions, TransportVersion minimumVersion, boolean useAggregateMetricDoubleWhenNotSupported, boolean useDenseVectorWhenNotSupported, boolean hasTimeSeriesAggregation, boolean trackUnmappedFieldIndices, ActionListener<Versioned<IndexResolution>> listener)	Like IndexResolver#resolveIndicesVersioned but for flat (CPS) queries.
void	resolveLookupIndices(String indexPattern, Set<String> fieldNames, TransportVersion minimumVersion, ActionListener<IndexResolution> listener)	Like IndexResolver#resolveIndicesVersioned but simplified and does not pass on the determined minimum transport version to the listener.
void	resolveMainIndicesVersioned(String indexPattern, Set<String> fieldNames, QueryBuilder requestFilter, boolean includeAllDimensions, TransportVersion minimumVersion, boolean useAggregateMetricDoubleWhenNotSupported, boolean useDenseVectorWhenNotSupported, boolean hasTimeSeriesAggregation, boolean trackUnmappedFieldIndices, IndicesExpressionGrouper indicesExpressionGrouper, ActionListener<Versioned<IndexResolution>> listener)	Perform a field caps request to resolve a pattern to one mapping (potentially compound, meaning it spans multiple indices).
static EsField	wrapIfPartiallyUnmapped(EsField field, String name, String fullName, Set<String> mappedIndices, int numberOfIndices)
static EsField	wrapIfPartiallyUnmapped(EsField field, String name, String fullName, Set<String> mappedIndices, int numberOfIndices, Map<Set<String>,Set<String>> indexDedupCache)
static EsField	wrapPartiallyUnmappedField(EsField field, String name, String fullName, Set<String> mappedIndices)
static EsField	wrapPartiallyUnmappedField(EsField field, String name, String fullName, Set<String> mappedIndices, Map<Set<String>,Set<String>> indexDedupCache)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ALL_FIELDS

public static final Set<String> ALL_FIELDS

INDEX_METADATA_FIELD

public static final Set<String> INDEX_METADATA_FIELD

UNMAPPED

public static final String UNMAPPED

See Also:

• Constant Field Values

DEFAULT_OPTIONS

public static final IndicesOptions DEFAULT_OPTIONS

DO_NOT_GROUP

public static final IndexResolver.OriginalIndexExtractor DO_NOT_GROUP

Constructor Details

IndexResolver

public IndexResolver(Client client,
 BooleanSupplier flattenedDataTypeEnabled)

Method Details

resolveLookupIndices

public void resolveLookupIndices(String indexPattern,
 Set<String> fieldNames,
 TransportVersion minimumVersion,
 ActionListener<IndexResolution> listener)

Like IndexResolver#resolveIndicesVersioned but simplified and does not pass on the determined minimum transport version to the listener.

resolveMainIndicesVersioned

public void resolveMainIndicesVersioned(String indexPattern,
 Set<String> fieldNames,
 QueryBuilder requestFilter,
 boolean includeAllDimensions,
 TransportVersion minimumVersion,
 boolean useAggregateMetricDoubleWhenNotSupported,
 boolean useDenseVectorWhenNotSupported,
 boolean hasTimeSeriesAggregation,
 boolean trackUnmappedFieldIndices,
 IndicesExpressionGrouper indicesExpressionGrouper,
 ActionListener<Versioned<IndexResolution>> listener)

Perform a field caps request to resolve a pattern to one mapping (potentially compound, meaning it spans multiple indices).

The field caps response contains the minimum transport version of all clusters that apply to the pattern, and it is used to deal with previously unsupported data types during resolution.

If a field's type is not supported on the minimum version, it will be DataType.UNSUPPORTED.

If the nodes are too old to include their minimum transport version in the field caps response, we'll assume TransportVersion.minimumCompatible().

The minimumVersion already known so far must be passed in and will be used instead of the minimum version from the field caps response if it is lower. During main index resolution, this is the local cluster's minimum version. This safeguards against using too new a version in case of FROM remote_only:* | ... queries that don't have any indices on the local cluster.

But it's also important for remote ENRICH resolution, because in CCS enrich policies are resolved on remote clusters, so the overall minimum transport version that the coordinating cluster observed must be passed in here to avoid inconsistencies.

The overall minimum version is updated using the field caps response and is passed on to the listener.

resolveFlatIndicesVersioned

public void resolveFlatIndicesVersioned(boolean lenient,
 String indexPattern,
 String projectRouting,
 Set<String> fieldNames,
 QueryBuilder requestFilter,
 boolean includeAllDimensions,
 TransportVersion minimumVersion,
 boolean useAggregateMetricDoubleWhenNotSupported,
 boolean useDenseVectorWhenNotSupported,
 boolean hasTimeSeriesAggregation,
 boolean trackUnmappedFieldIndices,
 ActionListener<Versioned<IndexResolution>> listener)

Like IndexResolver#resolveIndicesVersioned but for flat (CPS) queries. Set lenient to allow targets to be missing — used for ViewShadowRelation lookups, where finding nothing is the expected outcome when no remote project has an index matching the local view name. lenient=false is the default for the strict main index resolution path.

mergedMappings

public static IndexResolution mergedMappings(String indexPattern,
 boolean allowEmpty,
 IndexResolver.FieldsInfo fieldsInfo,
 boolean trackUnmappedFieldIndices,
 IndexResolver.OriginalIndexExtractor originalIndexExtractor)

wrapIfPartiallyUnmapped

public static EsField wrapIfPartiallyUnmapped(EsField field,
 String name,
 String fullName,
 Set<String> mappedIndices,
 int numberOfIndices)

wrapIfPartiallyUnmapped

public static EsField wrapIfPartiallyUnmapped(EsField field,
 String name,
 String fullName,
 Set<String> mappedIndices,
 int numberOfIndices,
 @Nullable
 Map<Set<String>,Set<String>> indexDedupCache)

wrapPartiallyUnmappedField

public static EsField wrapPartiallyUnmappedField(EsField field,
 String name,
 String fullName,
 Set<String> mappedIndices)

wrapPartiallyUnmappedField

public static EsField wrapPartiallyUnmappedField(EsField field,
 String name,
 String fullName,
 Set<String> mappedIndices,
 @Nullable
 Map<Set<String>,Set<String>> indexDedupCache)