Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class TimeSeriesRoutingHashFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.MetadataFieldMapper

org.elasticsearch.index.mapper.TimeSeriesRoutingHashFieldMapper

All Implemented Interfaces:

Iterable<Mapper>, ToXContent, ToXContentFragment

public class TimeSeriesRoutingHashFieldMapper
extends MetadataFieldMapper

Mapper for the _ts_routing_hash field. The field contains the routing hash, as calculated in coordinating nodes for docs in time-series indexes. It's stored to be retrieved and added as a prefix when reconstructing the _id field in search queries. The prefix can then used for routing Get and Delete requests (by doc id) to the right shard.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.MetadataFieldMapper

MetadataFieldMapper.Builder, MetadataFieldMapper.ConfigurableTypeParser, MetadataFieldMapper.FixedTypeParser, MetadataFieldMapper.TypeParser

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.FieldMapper

FieldMapper.BuilderParams, FieldMapper.Conflicts, FieldMapper.CopyTo, FieldMapper.DimensionBuilder, FieldMapper.MergeValidator<T>, FieldMapper.MultiFields, FieldMapper.Parameter<T>, FieldMapper.Serializer<T>, FieldMapper.SerializerCheck<T>, FieldMapper.SyntheticSourceMode, FieldMapper.SyntheticSourceSupport

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.Mapper

Mapper.IgnoreAbove, Mapper.SourceKeepMode

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DUMMY_ENCODED_VALUE
static final TimeSeriesRoutingHashFieldMapper	INSTANCE
static final String	NAME
static final MetadataFieldMapper.TypeParser	PARSER
static DocValueFormat	TS_ROUTING_HASH_DOC_VALUE_FORMAT

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

builderParams, COERCE_SETTING, deprecationLogger, IGNORE_MALFORMED_SETTING, mappedFieldType

Fields inherited from class org.elasticsearch.index.mapper.Mapper

SYNTHETIC_SOURCE_KEEP_FEATURE, SYNTHETIC_SOURCE_KEEP_INDEX_SETTING, SYNTHETIC_SOURCE_KEEP_PARAM

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
static int	decode(String routingId)
static String	encode(int routingId)
void	postParse(DocumentParserContext context)	Called after FieldMapper.parse(DocumentParserContext) on the RootObjectMapper.

Methods inherited from class org.elasticsearch.index.mapper.MetadataFieldMapper

getMergeBuilder, parseCreateField, preParse, syntheticSourceSupport, toXContent, updateableBoolParam

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

checkIncomingMergeType, copyTo, doParseMultiFields, doValidate, doXContentBody, executeScript, fieldType, fullPath, getTotalFieldsCount, hasScript, ignoreMalformed, indexAnalyzers, indexScriptValues, iterator, merge, multiFields, multiFieldsIterator, notFromDynamicTemplates, notInMultiFields, parse, parsesArrayValue, sourceKeepMode, sourcePathUsedBy, supportsParsingObject, syntheticFieldLoader, throwIndexingWithScriptParam, typeName, validate

Methods inherited from class org.elasticsearch.index.mapper.Mapper

freezeAndDeduplicateFieldType, getOffsetFieldName, internFieldName, leafName, supportStoringArrayOffsets, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

INSTANCE

public static final TimeSeriesRoutingHashFieldMapper INSTANCE

PARSER

public static final MetadataFieldMapper.TypeParser PARSER

TS_ROUTING_HASH_DOC_VALUE_FORMAT

public static DocValueFormat TS_ROUTING_HASH_DOC_VALUE_FORMAT

DUMMY_ENCODED_VALUE

public static final String DUMMY_ENCODED_VALUE

Method Details

postParse

public void postParse(DocumentParserContext context)

Description copied from class: MetadataFieldMapper

Called after FieldMapper.parse(DocumentParserContext) on the RootObjectMapper.

Overrides:

postParse in class MetadataFieldMapper

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

encode

public static String encode(int routingId)

decode

public static int decode(String routingId)