Package org.elasticsearch.xpack.esql.stats

Interface SearchStats

All Known Implementing Classes:

SearchContextStats, SearchStats.EmptySearchStats, SearchStats.UnsupportedSearchStats

public interface SearchStats

Interface for determining information about fields in the index. This is used by the optimizer to make decisions about how to optimize queries.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	SearchStats.EmptySearchStats	When there are no search stats available, for example when there are no search contexts, we have static results.
static class	SearchStats.UnsupportedSearchStats	A default implementat that throws UnsupportedOperationException on all methods.

Field Summary

Fields

Modifier and Type	Field	Description
static final SearchStats	EMPTY

Method Summary

Modifier and Type	Method	Description
boolean	canUseEqualityOnSyntheticSourceDelegate(FieldAttribute.FieldName name, String value)
default String	constantValue(FieldAttribute.FieldName name)	Returns the value for a field if it's a constant (eg.
long	count()
long	count(FieldAttribute.FieldName field)
long	count(FieldAttribute.FieldName field, org.apache.lucene.util.BytesRef value)
boolean	exists(FieldAttribute.FieldName field)
default MappedFieldType	fieldType(FieldAttribute.FieldName name)	Returns the mapped field type for the given field name, or null if the field is not found.
boolean	hasDocValues(FieldAttribute.FieldName field)
boolean	hasExactSubfield(FieldAttribute.FieldName field)
boolean	isIndexed(FieldAttribute.FieldName field)
boolean	isSingleValue(FieldAttribute.FieldName field)
Object	max(FieldAttribute.FieldName field)
Object	min(FieldAttribute.FieldName field)
boolean	supportsLoaderConfig(FieldAttribute.FieldName name, BlockLoaderFunctionConfig config, MappedFieldType.FieldExtractPreference preference)	Do all fields with the matching name support this loader config?
Map<ShardId,IndexMetadata>	targetShards()	Returns the target shards and their index metadata.

Field Details

EMPTY

static final SearchStats EMPTY

Method Details

exists

boolean exists(FieldAttribute.FieldName field)

isIndexed

boolean isIndexed(FieldAttribute.FieldName field)

hasDocValues

boolean hasDocValues(FieldAttribute.FieldName field)

hasExactSubfield

boolean hasExactSubfield(FieldAttribute.FieldName field)

count

long count()

count

long count(FieldAttribute.FieldName field)

count

long count(FieldAttribute.FieldName field,
 org.apache.lucene.util.BytesRef value)

min

Object min(FieldAttribute.FieldName field)

max

Object max(FieldAttribute.FieldName field)

isSingleValue

boolean isSingleValue(FieldAttribute.FieldName field)

canUseEqualityOnSyntheticSourceDelegate

boolean canUseEqualityOnSyntheticSourceDelegate(FieldAttribute.FieldName name,
 String value)

supportsLoaderConfig

boolean supportsLoaderConfig(FieldAttribute.FieldName name,
 BlockLoaderFunctionConfig config,
 MappedFieldType.FieldExtractPreference preference)

Do all fields with the matching name support this loader config?

constantValue

default String constantValue(FieldAttribute.FieldName name)

Returns the value for a field if it's a constant (eg. a constant_keyword with only one value for the involved indices). NULL if the field is not a constant.

fieldType

default MappedFieldType fieldType(FieldAttribute.FieldName name)

Returns the mapped field type for the given field name, or null if the field is not found.

targetShards

Map<ShardId,IndexMetadata> targetShards()

Returns the target shards and their index metadata.