Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class TimeSeriesIdFieldMapper.TimeSeriesIdBuilder

java.lang.Object

org.elasticsearch.index.mapper.TimeSeriesIdFieldMapper.TimeSeriesIdBuilder

All Implemented Interfaces:

DocumentDimensions

Enclosing class:

TimeSeriesIdFieldMapper

public static class TimeSeriesIdFieldMapper.TimeSeriesIdBuilder
extends Object
implements DocumentDimensions

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.DocumentDimensions

DocumentDimensions.Noop

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_DIMENSIONS

Constructor Summary

Constructors

Constructor	Description
TimeSeriesIdBuilder(IndexRouting.ExtractFromSource.Builder routingBuilder)

Method Summary

Modifier and Type	Method	Description
DocumentDimensions	addBoolean(String fieldName, boolean value)
DocumentDimensions	addIp(String fieldName, InetAddress value)
DocumentDimensions	addLong(String fieldName, long value)
DocumentDimensions	addString(String fieldName, org.apache.lucene.util.BytesRef utf8Value)	This overloaded method tries to take advantage of the fact that the UTF-8 value is already computed in some cases when we want to collect dimensions, so we can save re-computing the UTF-8 encoding.
DocumentDimensions	addUnsignedLong(String fieldName, long value)
BytesReference	buildLegacyTsid()
BytesReference	buildTsidHash()	Here we build the hash of the tsid using a similarity function so that we have a result with the following pattern: hash128(catenate(dimension field names)) + foreach(dimension field value, limit = MAX_DIMENSIONS) { hash32(dimension field value) } + hash128(catenate(dimension field values)) The idea is to be able to place 'similar' time series close to each other.
DocumentDimensions	validate(IndexSettings settings)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.index.mapper.DocumentDimensions

addString

Field Details

MAX_DIMENSIONS

public static final int MAX_DIMENSIONS

See Also:

• Constant Field Values

Constructor Details

TimeSeriesIdBuilder

public TimeSeriesIdBuilder(@Nullable
 IndexRouting.ExtractFromSource.Builder routingBuilder)

Method Details

buildLegacyTsid

public BytesReference buildLegacyTsid()
                               throws IOException

Throws:

IOException

buildTsidHash

public BytesReference buildTsidHash()

Here we build the hash of the tsid using a similarity function so that we have a result with the following pattern: hash128(catenate(dimension field names)) + foreach(dimension field value, limit = MAX_DIMENSIONS) { hash32(dimension field value) } + hash128(catenate(dimension field values)) The idea is to be able to place 'similar' time series close to each other. Two time series are considered 'similar' if they share the same dimensions (names and values).

addString

public DocumentDimensions addString(String fieldName,
 org.apache.lucene.util.BytesRef utf8Value)

Description copied from interface: DocumentDimensions

This overloaded method tries to take advantage of the fact that the UTF-8 value is already computed in some cases when we want to collect dimensions, so we can save re-computing the UTF-8 encoding.

Specified by:

addString in interface DocumentDimensions

addIp

public DocumentDimensions addIp(String fieldName,
 InetAddress value)

Specified by:

addIp in interface DocumentDimensions

addLong

public DocumentDimensions addLong(String fieldName,
 long value)

Specified by:

addLong in interface DocumentDimensions

addUnsignedLong

public DocumentDimensions addUnsignedLong(String fieldName,
 long value)

Specified by:

addUnsignedLong in interface DocumentDimensions

addBoolean

public DocumentDimensions addBoolean(String fieldName,
 boolean value)

Specified by:

addBoolean in interface DocumentDimensions

validate

public DocumentDimensions validate(IndexSettings settings)

Specified by:

validate in interface DocumentDimensions