Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class TsidExtractingIdFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.MetadataFieldMapper

org.elasticsearch.index.mapper.IdFieldMapper

org.elasticsearch.index.mapper.TsidExtractingIdFieldMapper

All Implemented Interfaces:

Iterable<Mapper>, ToXContent, ToXContentFragment

public class TsidExtractingIdFieldMapper
extends IdFieldMapper

A mapper for the _id field that builds the _id from the _tsid and @timestamp.

Nested Class Summary

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

IdFieldMapper.AbstractIdFieldType

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.DocValuesParameter, FieldMapper.MergeValidator<T>, FieldMapper.MultiFields, FieldMapper.Parameter<T>, FieldMapper.Serializer<T>, FieldMapper.SerializerCheck<T>, FieldMapper.SyntheticSourceMode, FieldMapper.SyntheticSourceSupport, FieldMapper.TextFamilyBuilder

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 TsidExtractingIdFieldMapper	INSTANCE

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

CONTENT_TYPE, NAME, PARSER

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_INDEX_SETTING, SYNTHETIC_SOURCE_KEEP_PARAM

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
static org.apache.lucene.util.BytesRef	createField(DocumentParserContext context, RoutingHashBuilder routingBuilder, org.apache.lucene.util.BytesRef tsid)
static String	createId(boolean dynamicMappersExists, RoutingHashBuilder routingBuilder, org.apache.lucene.util.BytesRef tsid, long timestamp, byte[] suffix)
static String	createId(int routingHash, org.apache.lucene.util.BytesRef tsid, long timestamp)
static String	createSyntheticId(org.apache.lucene.util.BytesRef tsid, long timestamp, int routingHash)
static org.apache.lucene.util.BytesRef	createSyntheticIdBytesRef(org.apache.lucene.util.BytesRef tsid, long timestamp, int routingHash)
String	documentDescription(DocumentParserContext context)	Description of the document being parsed used in error messages.
String	documentDescription(ParsedDocument parsedDocument)	Description of the document being indexed used after parsing for things like version conflicts.
static int	extractRoutingHashFromSyntheticId(org.apache.lucene.util.BytesRef id)	Extract the routing hash value by reading the last 4 bytes of the provided BytesRef representing a UID-encoded synthetic id.
static org.apache.lucene.util.BytesRef	extractTimeSeriesIdFromSyntheticId(org.apache.lucene.util.BytesRef id)
static long	extractTimestampFromId(byte[] id)
static long	extractTimestampFromSyntheticId(org.apache.lucene.util.BytesRef id)
String	reindexId(String id)	Build the _id to use on requests reindexing into indices using this _id.
static int	syntheticIdLength(org.apache.lucene.util.BytesRef tsid)	Returns the byte length of a synthetic _id for the given tsid.
static void	writeSyntheticId(org.apache.lucene.util.BytesRef tsid, long timestamp, int routingHash, byte[] dest, int destOffset)	Writes a synthetic _id directly into the destination byte array at the given offset.
static void	writeSyntheticId(org.apache.lucene.util.BytesRef tsid, long timestamp, org.apache.lucene.util.BytesRef routingHashBytes, byte[] dest, int destOffset)	Writes a synthetic _id directly into the destination byte array, using the Uid-encoded routing hash bytes.

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

contentType, indexAnalyzers, standardIdField, standardIdField, syntheticIdField, syntheticIdField

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

getMergeBuilder, parseCreateField, postParse, preParse, syntheticSourceSupport, toXContent, updateableBoolParam

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

checkIncomingMergeType, copyTo, createTypeParserWithLegacySupport, doParseMultiFields, doValidate, doXContentBody, executeScript, fieldType, fullPath, getTotalFieldsCount, hasScript, ignoreMalformed, indexScriptValues, iterator, multiFields, multiFieldsIterator, notFromDynamicTemplates, notInMultiFields, parse, parsesArrayValue, sourceKeepMode, sourcePathUsedBy, supportsParsingObject, syntheticFieldLoader, syntheticVectorsLoader, 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

INSTANCE

public static final TsidExtractingIdFieldMapper INSTANCE

Method Details

createField

public static org.apache.lucene.util.BytesRef createField(DocumentParserContext context,
 RoutingHashBuilder routingBuilder,
 org.apache.lucene.util.BytesRef tsid)

createId

public static String createId(int routingHash,
 org.apache.lucene.util.BytesRef tsid,
 long timestamp)

extractTimestampFromId

public static long extractTimestampFromId(byte[] id)

createId

public static String createId(boolean dynamicMappersExists,
 RoutingHashBuilder routingBuilder,
 org.apache.lucene.util.BytesRef tsid,
 long timestamp,
 byte[] suffix)

syntheticIdLength

public static int syntheticIdLength(org.apache.lucene.util.BytesRef tsid)

Returns the byte length of a synthetic _id for the given tsid.

writeSyntheticId

public static void writeSyntheticId(org.apache.lucene.util.BytesRef tsid,
 long timestamp,
 int routingHash,
 byte[] dest,
 int destOffset)

Writes a synthetic _id directly into the destination byte array at the given offset. The synthetic _id has the format: [_tsid + (Long.MAX_VALUE - timestamp) + routing hash].

writeSyntheticId

public static void writeSyntheticId(org.apache.lucene.util.BytesRef tsid,
 long timestamp,
 org.apache.lucene.util.BytesRef routingHashBytes,
 byte[] dest,
 int destOffset)

Writes a synthetic _id directly into the destination byte array, using the Uid-encoded routing hash bytes. This avoids decoding/encoding the routing hash through base64 and int conversion. The routingHashBytes are expected to be Uid-encoded (LE bytes, possibly with 0xfd escape prefix).

createSyntheticIdBytesRef

public static org.apache.lucene.util.BytesRef createSyntheticIdBytesRef(org.apache.lucene.util.BytesRef tsid,
 long timestamp,
 int routingHash)

createSyntheticId

public static String createSyntheticId(org.apache.lucene.util.BytesRef tsid,
 long timestamp,
 int routingHash)

extractTimeSeriesIdFromSyntheticId

public static org.apache.lucene.util.BytesRef extractTimeSeriesIdFromSyntheticId(org.apache.lucene.util.BytesRef id)

extractTimestampFromSyntheticId

public static long extractTimestampFromSyntheticId(org.apache.lucene.util.BytesRef id)

extractRoutingHashFromSyntheticId

public static int extractRoutingHashFromSyntheticId(org.apache.lucene.util.BytesRef id)

Extract the routing hash value by reading the last 4 bytes of the provided BytesRef representing a UID-encoded synthetic id.

Parameters:

id - an array of bytes representing the synthetic _id encoded with Uid.encodeId(java.lang.String).

Returns:

the routing hash value as an integer

documentDescription

public String documentDescription(DocumentParserContext context)

Description copied from class: IdFieldMapper

Description of the document being parsed used in error messages. Not called unless there is an error.

Specified by:

documentDescription in class IdFieldMapper

documentDescription

public String documentDescription(ParsedDocument parsedDocument)

Description copied from class: IdFieldMapper

Description of the document being indexed used after parsing for things like version conflicts.

Specified by:

documentDescription in class IdFieldMapper

reindexId

public String reindexId(String id)

Description copied from class: IdFieldMapper

Build the _id to use on requests reindexing into indices using this _id.

Specified by:

reindexId in class IdFieldMapper