Module org.elasticsearch.server

Package org.elasticsearch.index.codec

Class PerFieldMapperCodec

java.lang.Object

org.apache.lucene.codecs.Codec

org.apache.lucene.codecs.FilterCodec

org.elasticsearch.index.codec.CodecService.DeduplicateFieldInfosCodec

org.elasticsearch.index.codec.Elasticsearch93Lucene104Codec

org.elasticsearch.index.codec.PerFieldMapperCodec

All Implemented Interfaces:

org.apache.lucene.util.NamedSPILoader.NamedSPI

public final class PerFieldMapperCodec
extends Elasticsearch93Lucene104Codec

This Lucene codec provides the default PostingsFormat and KnnVectorsFormat for Elasticsearch. It utilizes the MapperService to lookup a PostingsFormat and KnnVectorsFormat per field. This allows users to change the low level postings format and vectors format for individual fields per index in real time via the mapping API. If no specific postings format or vector format is configured for a specific field the default postings or vector format is used.

Field Summary

Fields inherited from class org.apache.lucene.codecs.FilterCodec

delegate

Constructor Summary

Constructors

Constructor	Description
PerFieldMapperCodec(Zstd814StoredFieldsFormat.Mode compressionMode, MapperService mapperService, BigArrays bigArrays, ThreadPool threadPool)

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.codecs.DocValuesFormat	getDocValuesFormatForField(String field)	Returns the docvalues format that should be used for writing new segments of field .
org.apache.lucene.codecs.KnnVectorsFormat	getKnnVectorsFormatForField(String field)	Returns the vectors format that should be used for writing new segments of field
org.apache.lucene.codecs.PostingsFormat	getPostingsFormatForField(String field)	Returns the postings format that should be used for writing new segments of field.

Methods inherited from class org.elasticsearch.index.codec.Elasticsearch93Lucene104Codec

docValuesFormat, knnVectorsFormat, postingsFormat, storedFieldsFormat

Methods inherited from class org.elasticsearch.index.codec.CodecService.DeduplicateFieldInfosCodec

delegate, fieldInfosFormat

Methods inherited from class org.apache.lucene.codecs.FilterCodec

compoundFormat, liveDocsFormat, normsFormat, pointsFormat, segmentInfoFormat, termVectorsFormat

Methods inherited from class org.apache.lucene.codecs.Codec

availableCodecs, forName, getDefault, getName, reloadCodecs, setDefault, toString

Methods inherited from class java.lang.Object

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

Constructor Details

PerFieldMapperCodec

public PerFieldMapperCodec(Zstd814StoredFieldsFormat.Mode compressionMode,
 MapperService mapperService,
 BigArrays bigArrays,
 ThreadPool threadPool)

Method Details

getPostingsFormatForField

public org.apache.lucene.codecs.PostingsFormat getPostingsFormatForField(String field)

Description copied from class: Elasticsearch93Lucene104Codec

Returns the postings format that should be used for writing new segments of field.

The default implementation always returns "Lucene912".

WARNING: if you subclass, you are responsible for index backwards compatibility: future version of Lucene are only guaranteed to be able to read the default implementation,

Overrides:

getPostingsFormatForField in class Elasticsearch93Lucene104Codec

getKnnVectorsFormatForField

public org.apache.lucene.codecs.KnnVectorsFormat getKnnVectorsFormatForField(String field)

Description copied from class: Elasticsearch93Lucene104Codec

Returns the vectors format that should be used for writing new segments of field

The default implementation always returns "Lucene912".

WARNING: if you subclass, you are responsible for index backwards compatibility: future version of Lucene are only guaranteed to be able to read the default implementation.

Overrides:

getKnnVectorsFormatForField in class Elasticsearch93Lucene104Codec

getDocValuesFormatForField

public org.apache.lucene.codecs.DocValuesFormat getDocValuesFormatForField(String field)

Description copied from class: Elasticsearch93Lucene104Codec

Returns the docvalues format that should be used for writing new segments of field .

The default implementation always returns "Lucene912".

WARNING: if you subclass, you are responsible for index backwards compatibility: future version of Lucene are only guaranteed to be able to read the default implementation.

Overrides:

getDocValuesFormatForField in class Elasticsearch93Lucene104Codec