Package org.opensearch.index.mapper
Class SeqNoFieldMapper
java.lang.Object
org.opensearch.index.mapper.Mapper
org.opensearch.index.mapper.FieldMapper
org.opensearch.index.mapper.ParametrizedFieldMapper
org.opensearch.index.mapper.MetadataFieldMapper
org.opensearch.index.mapper.SeqNoFieldMapper
- All Implemented Interfaces:
java.lang.Cloneable
,java.lang.Iterable<Mapper>
,org.opensearch.common.xcontent.ToXContent
,org.opensearch.common.xcontent.ToXContentFragment
public class SeqNoFieldMapper extends MetadataFieldMapper
Mapper for the
_seq_no
field.
We expect to use the seq# for sorting, during collision checking and for
doing range searches. Therefore the _seq_no
field is stored both
as a numeric doc value and as numeric indexed field.
This mapper also manages the primary term field, which has no OpenSearch named
equivalent. The primary term is only used during collision after receiving
identical seq# values for two document copies. The primary term is stored as
a doc value field without being indexed, since it is only intended for use
as a key-value lookup.-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SeqNoFieldMapper.SequenceIDFields
A sequence ID, which is made up of a sequence number (both the searchable and doc_value version of the field) and the primary term.Nested classes/interfaces inherited from class org.opensearch.index.mapper.MetadataFieldMapper
MetadataFieldMapper.Builder, MetadataFieldMapper.ConfigurableTypeParser, MetadataFieldMapper.FixedTypeParser, MetadataFieldMapper.TypeParser
Nested classes/interfaces inherited from class org.opensearch.index.mapper.ParametrizedFieldMapper
ParametrizedFieldMapper.Parameter<T>, ParametrizedFieldMapper.Serializer<T>, ParametrizedFieldMapper.SerializerCheck<T>
Nested classes/interfaces inherited from class org.opensearch.index.mapper.FieldMapper
FieldMapper.CopyTo, FieldMapper.MultiFields
Nested classes/interfaces inherited from class org.opensearch.index.mapper.Mapper
Mapper.BuilderContext
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CONTENT_TYPE
static java.lang.String
NAME
static MetadataFieldMapper.TypeParser
PARSER
static java.lang.String
PRIMARY_TERM_NAME
static java.lang.String
TOMBSTONE_NAME
Fields inherited from class org.opensearch.index.mapper.FieldMapper
COERCE_SETTING, copyTo, fieldType, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields
-
Constructor Summary
Constructors Constructor Description SeqNoFieldMapper()
-
Method Summary
Modifier and Type Method Description protected java.lang.String
contentType()
void
postParse(ParseContext context)
Called afterFieldMapper.parse(ParseContext)
on theRootObjectMapper
.void
preParse(ParseContext context)
Called beforeFieldMapper.parse(ParseContext)
on theRootObjectMapper
.Methods inherited from class org.opensearch.index.mapper.MetadataFieldMapper
getMergeBuilder, parseCreateField, toXContent, updateableBoolParam
Methods inherited from class org.opensearch.index.mapper.ParametrizedFieldMapper
doXContentBody, merge, mergeOptions
Methods inherited from class org.opensearch.index.mapper.FieldMapper
clone, copyTo, createFieldNamesField, docValuesByDefault, doValidate, doXContentAnalyzers, fieldType, indexedByDefault, indexOptionToString, iterator, multiFields, name, parse, parsesArrayValue, storedByDefault, typeName, validate
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
CONTENT_TYPE
public static final java.lang.String CONTENT_TYPE- See Also:
- Constant Field Values
-
PRIMARY_TERM_NAME
public static final java.lang.String PRIMARY_TERM_NAME- See Also:
- Constant Field Values
-
TOMBSTONE_NAME
public static final java.lang.String TOMBSTONE_NAME- See Also:
- Constant Field Values
-
PARSER
-
-
Constructor Details
-
SeqNoFieldMapper
public SeqNoFieldMapper()
-
-
Method Details
-
preParse
Description copied from class:MetadataFieldMapper
Called beforeFieldMapper.parse(ParseContext)
on theRootObjectMapper
.- Overrides:
preParse
in classMetadataFieldMapper
- Throws:
java.io.IOException
-
postParse
Description copied from class:MetadataFieldMapper
Called afterFieldMapper.parse(ParseContext)
on theRootObjectMapper
.- Overrides:
postParse
in classMetadataFieldMapper
- Throws:
java.io.IOException
-
contentType
protected java.lang.String contentType()- Specified by:
contentType
in classFieldMapper
-