Package org.opensearch.search.aggregations.support

package org.opensearch.search.aggregations.support

This package holds shared code for the aggregations framework, especially around dealing with values.

Key Classes

ValuesSource and its subclasses

These are thin wrappers which provide a unified interface to different ways of getting input data (e.g. DocValues from Lucene, or script output). A class hierarchy defines the type of values returned by the source. The top level sub-classes define type-specific behavior, such as ValuesSource.Numeric.isFloatingPoint(). Second level subclasses are then specialized based on where they read values from, e.g. script or field cases. There are also adapter classes like org.opensearch.search.aggregations.bucket.geogrid.CellIdSource which do run-time conversion from one type to another, often dependent on a user specified parameter (precision in that case).

ValuesSourceRegistry

ValuesSourceRegistry stores the mappings for what types are supported by what aggregations. It is configured at startup, when SearchModule is configuring aggregations. It shouldn't be necessary to access the registry in most cases, but you can get a read copy from QueryShardContext.getValuesSourceRegistry() if necessary.

ValuesSourceType

ValuesSourceTypes are the quantum of support in the aggregations framework, and provide a common language between fields and aggregations. Fields which support aggregation set a ValuesSourceType on their IndexFieldData implementations, and aggregations register what types they support via one of the ValuesSourceRegistry.Builder.register(org.opensearch.search.aggregations.support.ValuesSourceRegistry.RegistryKey<T>, org.opensearch.search.aggregations.support.ValuesSourceType, T, boolean) methods. The VaulesSourceType itself holds information on how to with values of that type, including methods for creating ValuesSource instances and DocValueFormat instances.

ValuesSourceConfig

There are two things going on in ValuesSourceConfig. First, there is a collection of static factory methods to build valid configs for different situations. ValuesSourceAggregationBuilder.resolveConfig(org.opensearch.index.query.QueryShardContext) has a good default for what to call here and generally aggregations shouldn't need to deviate from that.

Once properly constructed, the ValuesSourceConfig provides access to the ValuesSource instance, as well as related information like the formatter. Aggregations are free to use this information as needed, such as Max and Min which inspect the field context to see if they can apply an optimization.

Classes we are trying to phase out

ValueType

This class is primarily used for parsing user type hints, and is deprecated for new use. Work is ongoing to remove it from existing code.

Related Packages

Package	Description
org.opensearch.search.aggregations	Builds analytic information over all hits in a search request.
org.opensearch.search.aggregations.support.values	Base Values Source for Aggregations package.
org.opensearch.search.aggregations.bucket	Aggregations module
org.opensearch.search.aggregations.metrics	Aggregations module
org.opensearch.search.aggregations.pipeline	Pipeline Aggregation package.

Class	Description
AggregationInfo	Data describing an agg
AggregationInspectionHelper	Provides a set of static helpers to determine if a particular type of InternalAggregation "has a value" or not.
AggregationPath	A path that can be used to sort/order buckets (in some multi-bucket aggregations, e.g.
AggregationPath.PathElement	Element in an agg path
AggregationUsageService	Service to track telemetry about aggregations
AggregationUsageService.Builder	Builder for the Agg usage service to track telemetry
BaseMultiValuesSourceFieldConfig	A configuration that tells aggregation how to retrieve data from index in order to run a specific aggregation.
BaseMultiValuesSourceFieldConfig.Builder<C extends BaseMultiValuesSourceFieldConfig,B extends BaseMultiValuesSourceFieldConfig.Builder<C,B>>	Base builder for the multi values source field configuration
CoreValuesSourceType	CoreValuesSourceType holds the ValuesSourceType implementations for the core aggregations package.
FieldContext	Used by all field data based aggregators.
MissingValues	Utility class that allows to return views of ValuesSources that replace the missing value with a configured value.
MultiTermsValuesSourceConfig	A configuration that used by multi_terms aggregations.
MultiTermsValuesSourceConfig.Builder	Builder for the multi terms values source configuration
MultiTermsValuesSourceConfig.ParserSupplier	Parser supplier function
MultiValuesSource<VS extends ValuesSource>	Class to encapsulate a set of ValuesSource objects labeled by field name
MultiValuesSource.NumericMultiValuesSource	Numeric format
MultiValuesSourceAggregationBuilder<AB extends MultiValuesSourceAggregationBuilder<AB>>	Similar to ValuesSourceAggregationBuilder, except it references multiple ValuesSources (e.g.
MultiValuesSourceAggregationBuilder.LeafOnly<AB extends MultiValuesSourceAggregationBuilder<AB>>	Base leaf only class
MultiValuesSourceAggregatorFactory	Base class for MultiValuesSource aggregator factories
MultiValuesSourceFieldConfig	Base field configuration class for multi values
MultiValuesSourceFieldConfig.Builder	Builder for the field config
MultiValuesSourceParseHelper	Helper class to parse multi values sources
ValuesSource	Base class for a ValuesSource; the primitive data for an agg
ValuesSource.Bytes	Bytes type
ValuesSource.Bytes.FieldData	Field data without ordinals
ValuesSource.Bytes.Script	ValuesSource implementation for stand alone scripts returning a Bytes value
ValuesSource.Bytes.WithOrdinals	Provides ordinals for bytes
ValuesSource.Bytes.WithOrdinals.FieldData	Field data for the bytes values source
ValuesSource.Bytes.WithScript	ValuesSource subclass for Bytes fields with a Value Script applied
ValuesSource.GeoPoint	Geo point values source
ValuesSource.GeoPoint.Fielddata	Field data for geo point values source
ValuesSource.GeoShape	The primitive data type for doing an aggregation on the GeoShape
ValuesSource.GeoShape.FieldData	Field data for geo shape values source
ValuesSource.Numeric	Numeric values source type
ValuesSource.Numeric.FieldData	Field data for numerics
ValuesSource.Numeric.Script	ValuesSource implementation for stand alone scripts returning a Numeric value
ValuesSource.Numeric.WithScript	ValuesSource subclass for Numeric fields with a Value Script applied
ValuesSource.Range	Range type
ValuesSourceAggregationBuilder<AB extends ValuesSourceAggregationBuilder<AB>>	Base class for all values source agg builders
ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<AB>>	Base leaf only
ValuesSourceAggregatorFactory	Base class for all values source agg factories
ValuesSourceConfig	A configuration that tells aggregations how to retrieve data from the index in order to run a specific aggregation.
ValuesSourceRegistry	ValuesSourceRegistry holds the mapping from ValuesSourceTypes to functions for building aggregation components.
ValuesSourceRegistry.Builder	Builder for the values source registry
ValuesSourceRegistry.RegistryKey<T>	The registry key for the values source registry key
ValuesSourceType	======= ValuesSourceType represents a collection of fields that share a common set of operations, for example all numeric fields.
ValueType	Enum to signal what kind of value type is used in the aggregator