Module org.elasticsearch.server
Package org.elasticsearch.index.codec

Class Elasticsearch814Codec

java.lang.Object
org.apache.lucene.codecs.Codec
org.apache.lucene.codecs.FilterCodec
org.elasticsearch.index.codec.Elasticsearch814Codec
All Implemented Interfaces:
org.apache.lucene.util.NamedSPILoader.NamedSPI
Direct Known Subclasses:
PerFieldMapperCodec
public class Elasticsearch814Codec extends org.apache.lucene.codecs.FilterCodec
Elasticsearch codec as of 8.14. This extends the Lucene 9.9 codec to compressed stored fields with ZSTD instead of LZ4/DEFLATE. See Zstd814StoredFieldsFormat.

  • Field Summary

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

    delegate

  • Constructor Summary

    Constructors
    Constructor
    Description
    Elasticsearch814Codec()
    Public no-arg constructor, needed for SPI loading at read-time.
    Elasticsearch814Codec(Zstd814StoredFieldsFormat.Mode mode)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    final org.apache.lucene.codecs.DocValuesFormat
    docValuesFormat()
     
    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.
    final org.apache.lucene.codecs.KnnVectorsFormat
    knnVectorsFormat()
     
    final org.apache.lucene.codecs.PostingsFormat
    postingsFormat()
     
    org.apache.lucene.codecs.StoredFieldsFormat
    storedFieldsFormat()
     

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

    compoundFormat, fieldInfosFormat, 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

    • Elasticsearch814Codec

      public Elasticsearch814Codec()
      Public no-arg constructor, needed for SPI loading at read-time.

    • Elasticsearch814Codec

      public Elasticsearch814Codec(Zstd814StoredFieldsFormat.Mode mode)
      Constructor. Takes a Zstd814StoredFieldsFormat.Mode that describes whether to optimize for retrieval speed at the expense of worse space-efficiency or vice-versa.

  • Method Details

    • storedFieldsFormat

      public org.apache.lucene.codecs.StoredFieldsFormat storedFieldsFormat()
      Overrides:
      storedFieldsFormat in class org.apache.lucene.codecs.FilterCodec

    • postingsFormat

      public final org.apache.lucene.codecs.PostingsFormat postingsFormat()
      Overrides:
      postingsFormat in class org.apache.lucene.codecs.FilterCodec

    • docValuesFormat

      public final org.apache.lucene.codecs.DocValuesFormat docValuesFormat()
      Overrides:
      docValuesFormat in class org.apache.lucene.codecs.FilterCodec

    • knnVectorsFormat

      public final org.apache.lucene.codecs.KnnVectorsFormat knnVectorsFormat()
      Overrides:
      knnVectorsFormat in class org.apache.lucene.codecs.FilterCodec

    • getPostingsFormatForField

      public org.apache.lucene.codecs.PostingsFormat getPostingsFormatForField(String field)
      Returns the postings format that should be used for writing new segments of field.

      The default implementation always returns "Lucene99".

      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,

    • getDocValuesFormatForField

      public org.apache.lucene.codecs.DocValuesFormat getDocValuesFormatForField(String field)
      Returns the docvalues format that should be used for writing new segments of field .

      The default implementation always returns "Lucene99".

      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.

    • getKnnVectorsFormatForField

      public org.apache.lucene.codecs.KnnVectorsFormat getKnnVectorsFormatForField(String field)
      Returns the vectors format that should be used for writing new segments of field

      The default implementation always returns "Lucene95".

      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.