Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class FieldMapper.DocValuesParameter

java.lang.Object

org.elasticsearch.index.mapper.FieldMapper.Parameter<FieldMapper.DocValuesParameter.Values>

org.elasticsearch.index.mapper.FieldMapper.DocValuesParameter

All Implemented Interfaces:

Supplier<FieldMapper.DocValuesParameter.Values>

Enclosing class:

FieldMapper

public static final class FieldMapper.DocValuesParameter
extends FieldMapper.Parameter<FieldMapper.DocValuesParameter.Values>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FieldMapper.DocValuesParameter.Values

Field Summary

Fields

Modifier and Type	Field	Description
final Optional<FieldMapper.Parameter<FieldMapper.DocValuesParameter.Values.Cardinality>>	cardinalityParameter
static FeatureFlag	EXTENDED_DOC_VALUES_PARAMS_FF
final FieldMapper.Parameter<FieldMapper.DocValuesParameter.Values.MultiValue>	multiValueParameter
static final String	PARAMETER_NAME

Fields inherited from class org.elasticsearch.index.mapper.FieldMapper.Parameter

name

Method Summary

Modifier and Type	Method	Description
static FieldMapper.DocValuesParameter	arraysWithCardinality(FieldMapper.DocValuesParameter.Values defaultValue, Function<FieldMapper,FieldMapper.DocValuesParameter.Values> initializer)	Factory for field types that support cardinality.
void	parse(String field, MappingParserContext context, Object value)	Parses the doc_values parameter from the field mapping.
void	setValue(FieldMapper.DocValuesParameter.Values value)	Sets the current value of the parameter
static FieldMapper.DocValuesParameter	sorted(FieldMapper.DocValuesParameter.Values defaultValue, Function<FieldMapper,FieldMapper.DocValuesParameter.Values> initializer)	Factory for field types that do not support cardinality.
static FieldMapper.DocValuesParameter	sortedSet(FieldMapper.DocValuesParameter.Values defaultValue, Function<FieldMapper,FieldMapper.DocValuesParameter.Values> initializer)	Factory for field types that do not support cardinality.
static FieldMapper.DocValuesParameter	sortedSetWithCardinality(FieldMapper.DocValuesParameter.Values defaultValue, Function<FieldMapper,FieldMapper.DocValuesParameter.Values> initializer)	Factory for field types that support cardinality.
protected void	toXContent(XContentBuilder builder, boolean includeDefaults)

Methods inherited from class org.elasticsearch.index.mapper.FieldMapper.Parameter

acceptsNull, addDeprecatedName, addValidator, alwaysSerialize, analyzerParam, analyzerParam, boolParam, boolParam, canAcceptNull, deprecated, docValuesParam, enumParam, enumParam, explicitBoolParam, get, getDefaultValue, getValue, ignoreAboveParam, indexParam, indexParam, indexParam, intParam, isConfigured, isSet, metaParam, neverSerialize, normsParam, normsParam, onScriptErrorParam, precludesParameters, requiresParameter, restrictedEnumParam, restrictedEnumParam, scriptParam, setMergeValidator, setSerializerCheck, storeParam, storeParam, stringArrayParam, stringParam, stringParam, useTimeSeriesDocValuesSkippers

Methods inherited from class java.lang.Object

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

Field Details

PARAMETER_NAME

public static final String PARAMETER_NAME

See Also:

• Constant Field Values

EXTENDED_DOC_VALUES_PARAMS_FF

public static FeatureFlag EXTENDED_DOC_VALUES_PARAMS_FF

cardinalityParameter

public final Optional<FieldMapper.Parameter<FieldMapper.DocValuesParameter.Values.Cardinality>> cardinalityParameter

multiValueParameter

public final FieldMapper.Parameter<FieldMapper.DocValuesParameter.Values.MultiValue> multiValueParameter

Method Details

sorted

public static FieldMapper.DocValuesParameter sorted(FieldMapper.DocValuesParameter.Values defaultValue,
 Function<FieldMapper,FieldMapper.DocValuesParameter.Values> initializer)

Factory for field types that do not support cardinality. Use for numeric types that use SortedNumericDocValuesField.

sortedSet

public static FieldMapper.DocValuesParameter sortedSet(FieldMapper.DocValuesParameter.Values defaultValue,
 Function<FieldMapper,FieldMapper.DocValuesParameter.Values> initializer)

Factory for field types that do not support cardinality. Use for types that use SortedSetDocValuesField (e.g. IP, flattened).

sortedSetWithCardinality

public static FieldMapper.DocValuesParameter sortedSetWithCardinality(FieldMapper.DocValuesParameter.Values defaultValue,
 Function<FieldMapper,FieldMapper.DocValuesParameter.Values> initializer)

Factory for field types that support cardinality. Use for keyword fields.

arraysWithCardinality

public static FieldMapper.DocValuesParameter arraysWithCardinality(FieldMapper.DocValuesParameter.Values defaultValue,
 Function<FieldMapper,FieldMapper.DocValuesParameter.Values> initializer)

Factory for field types that support cardinality. Use for text-family fields (text, match_only_text).

parse

public void parse(String field,
 MappingParserContext context,
 Object value)

Parses the doc_values parameter from the field mapping.

Doc values can be configured in the following ways:

• "doc_values": false - doc_values disabled
• "doc_values": true - doc_values enabled with defaults
• "doc_values": { "cardinality": "low" } - doc_values enabled with LOW cardinality
• "doc_values": { "cardinality": "high" } - doc_values enabled with HIGH cardinality
• "doc_values": { "multi_value": "no" } - single value enforced per document
• "doc_values": { "multi_value": "sorted" } - multiple values sorted per document
• "doc_values": { "multi_value": "sorted_set" } - multiple values sorted and deduplicated per document
• "doc_values": { "multi_value": "arrays" } - multiple values stored as-is (no sorting or deduplication)

Not all multi_value options are supported by every field type; unsupported options are rejected at mapping parse time.

The presence of doc_values as a map indicates the user wants doc_values enabled. The map format allows specifying additional cardinality and multi_value settings.

Overrides:

parse in class FieldMapper.Parameter<FieldMapper.DocValuesParameter.Values>

Parameters:

field - the field name

context - the parser context

value - the object

setValue

public void setValue(FieldMapper.DocValuesParameter.Values value)

Description copied from class: FieldMapper.Parameter

Sets the current value of the parameter

Overrides:

setValue in class FieldMapper.Parameter<FieldMapper.DocValuesParameter.Values>

toXContent

protected void toXContent(XContentBuilder builder,
 boolean includeDefaults)
                   throws IOException

Overrides:

toXContent in class FieldMapper.Parameter<FieldMapper.DocValuesParameter.Values>

Throws:

IOException