Package org.opensearch.index.codec

Class PerFieldMappingPostingFormatCodec

java.lang.Object
org.apache.lucene.codecs.Codec
org.apache.lucene.codecs.lucene99.Lucene99Codec
org.opensearch.index.codec.PerFieldMappingPostingFormatCodec
All Implemented Interfaces:
org.apache.lucene.util.NamedSPILoader.NamedSPI
public class PerFieldMappingPostingFormatCodec extends org.apache.lucene.codecs.lucene99.Lucene99Codec
This postings format is the default PostingsFormat for OpenSearch. It utilizes the MapperService to lookup a PostingsFormat per field. This allows users to change the low level postings format for individual fields per index in real time via the mapping API. If no specific postings format is configured for a specific field the default postings format is used.
Opensearch.internal:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.apache.lucene.codecs.lucene99.Lucene99Codec

    org.apache.lucene.codecs.lucene99.Lucene99Codec.Mode

  • Constructor Summary

    Constructors
    Constructor
    Description
    PerFieldMappingPostingFormatCodec(org.apache.lucene.codecs.lucene99.Lucene99Codec.Mode compressionMode, MapperService mapperService, org.apache.logging.log4j.Logger logger)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.lucene.codecs.DocValuesFormat
    getDocValuesFormatForField(String field)
     
    org.apache.lucene.codecs.PostingsFormat
    getPostingsFormatForField(String field)
     

    Methods inherited from class org.apache.lucene.codecs.lucene99.Lucene99Codec

    compoundFormat, docValuesFormat, fieldInfosFormat, getKnnVectorsFormatForField, knnVectorsFormat, liveDocsFormat, normsFormat, pointsFormat, postingsFormat, segmentInfoFormat, storedFieldsFormat, 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

    • PerFieldMappingPostingFormatCodec

      public PerFieldMappingPostingFormatCodec(org.apache.lucene.codecs.lucene99.Lucene99Codec.Mode compressionMode, MapperService mapperService, org.apache.logging.log4j.Logger logger)

  • Method Details

    • getPostingsFormatForField

      public org.apache.lucene.codecs.PostingsFormat getPostingsFormatForField(String field)
      Overrides:
      getPostingsFormatForField in class org.apache.lucene.codecs.lucene99.Lucene99Codec

    • getDocValuesFormatForField

      public org.apache.lucene.codecs.DocValuesFormat getDocValuesFormatForField(String field)
      Overrides:
      getDocValuesFormatForField in class org.apache.lucene.codecs.lucene99.Lucene99Codec