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

Record Class TSDBDocValuesFormatConfig

java.lang.Object
java.lang.Record
org.elasticsearch.index.codec.tsdb.TSDBDocValuesFormatConfig
Record Components:
version - version identifiers for header validation and feature gating
termsDict - terms dictionary block layout parameters
skipIndex - skip index geometry parameters
numeric - numeric encoding parameters
binary - binary doc values compression parameters
directMonotonicBlockShift - block shift for DirectMonotonicWriter used across all field types
writePrefixPartitions - whether to write prefix-based partition metadata for the primary sort field
public record TSDBDocValuesFormatConfig(TSDBDocValuesFormatConfig.VersionConfig version, TSDBDocValuesFormatConfig.TermsDictConfig termsDict, TSDBDocValuesFormatConfig.SkipIndexConfig skipIndex, TSDBDocValuesFormatConfig.NumericConfig numeric, TSDBDocValuesFormatConfig.BinaryConfig binary, int directMonotonicBlockShift, boolean writePrefixPartitions) extends Record
Format-specific configuration that varies per codec version. Groups related parameters into sub-records and provides delegation methods for convenient flat access.

  • Constructor Details

  • Method Details

    • versionStart

      public int versionStart()
      Returns:
      minimum format version for header validation

    • versionCurrent

      public int versionCurrent()
      Returns:
      format version to write in file headers

    • versionLargeBlocks

      public int versionLargeBlocks()
      Returns:
      version at which large numeric blocks were introduced

    • versionBinaryCompression

      public int versionBinaryCompression()
      Returns:
      version at which binary DV compression was introduced

    • versionPrefixPartitions

      public int versionPrefixPartitions()
      Returns:
      version at which prefix partitions were introduced

    • termsBlockLz4Mask

      public int termsBlockLz4Mask()
      Returns:
      terms dict block mask

    • termsBlockLz4Shift

      public int termsBlockLz4Shift()
      Returns:
      terms dict block shift

    • termsReverseIndexShift

      public int termsReverseIndexShift()
      Returns:
      terms dict reverse index shift

    • termsReverseIndexMask

      public int termsReverseIndexMask()
      Returns:
      terms dict reverse index mask

    • skipIndexLevelShift

      public int skipIndexLevelShift()
      Returns:
      number of intervals per level, expressed as a shift

    • skipIndexMaxLevel

      public int skipIndexMaxLevel()
      Returns:
      maximum number of skip index levels

    • skipIndexIntervalSize

      public int skipIndexIntervalSize()
      Returns:
      number of documents per skip index interval

    • numericBlockShift

      public int numericBlockShift()
      Returns:
      block shift for numeric encoding

    • ordinalRangeBlockShift

      public int ordinalRangeBlockShift()
      Returns:
      block shift for ordinal range encoding

    • minDocsPerOrdinalForRangeEncoding

      public int minDocsPerOrdinalForRangeEncoding()
      Returns:
      minimum docs per ordinal for range encoding

    • blockBytesThreshold

      public int blockBytesThreshold()
      Returns:
      threshold for binary block size in bytes

    • blockCountThreshold

      public int blockCountThreshold()
      Returns:
      threshold for binary block value count

    • enablePerBlockCompression

      public boolean enablePerBlockCompression()
      Returns:
      whether per-block compression is enabled

    • binaryCompressionMode

      public BinaryDVCompressionMode binaryCompressionMode()
      Returns:
      compression algorithm for binary doc values

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • version

      public TSDBDocValuesFormatConfig.VersionConfig version()
      Returns the value of the version record component.
      Returns:
      the value of the version record component

    • termsDict

      public TSDBDocValuesFormatConfig.TermsDictConfig termsDict()
      Returns the value of the termsDict record component.
      Returns:
      the value of the termsDict record component

    • skipIndex

      public TSDBDocValuesFormatConfig.SkipIndexConfig skipIndex()
      Returns the value of the skipIndex record component.
      Returns:
      the value of the skipIndex record component

    • numeric

      public TSDBDocValuesFormatConfig.NumericConfig numeric()
      Returns the value of the numeric record component.
      Returns:
      the value of the numeric record component

    • binary

      public TSDBDocValuesFormatConfig.BinaryConfig binary()
      Returns the value of the binary record component.
      Returns:
      the value of the binary record component

    • directMonotonicBlockShift

      public int directMonotonicBlockShift()
      Returns the value of the directMonotonicBlockShift record component.
      Returns:
      the value of the directMonotonicBlockShift record component

    • writePrefixPartitions

      public boolean writePrefixPartitions()
      Returns the value of the writePrefixPartitions record component.
      Returns:
      the value of the writePrefixPartitions record component