Package org.apache.druid.segment

Class IndexSpec

java.lang.Object

org.apache.druid.segment.IndexSpec

public class IndexSpec
extends Object

IndexSpec defines segment storage format options to be used at indexing time, such as bitmap type, and column compression formats.

IndexSpec is specified as part of the TuningConfig for the corresponding index task. Fields which are not explicitly defined by the operator default to null values, callers must call getEffectiveSpec() to fill in these null values, which will replace nulls first with any system defaults defined in getDefault() falling back to hard coded defaults.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IndexSpec.Builder

Constructor Summary

Constructors

Constructor

Description

IndexSpec(BitmapSerdeFactory bitmapSerdeFactory, CompressionStrategy metadataCompression, CompressionStrategy dimensionCompression, StringEncodingStrategy stringDictionaryEncoding, CompressionStrategy metricCompression, CompressionFactory.LongEncodingStrategy longEncoding, CompressionStrategy complexMetricCompression, CompressionStrategy jsonCompression, SegmentizerFactory segmentLoader, NestedCommonFormatColumnFormatSpec autoColumnFormatSpec, StringColumnFormatSpec stringColumnFormatSpec)

Creates an IndexSpec with the given storage format settings.

Method Summary

Modifier and Type	Method	Description
static IndexSpec.Builder	builder()
boolean	equals(Object o)
NestedCommonFormatColumnFormatSpec	getAutoColumnFormatSpec()
BitmapSerdeFactory	getBitmapSerdeFactory()
CompressionStrategy	getComplexMetricCompression()
static IndexSpec	getDefault()
CompressionStrategy	getDimensionCompression()
IndexSpec	getEffectiveSpec()	Populate all null fields of IndexSpec, first from getDefault() and finally falling back to hard coded defaults if no overrides are defined.
CompressionStrategy	getJsonCompression()	Deprecated.
CompressionFactory.LongEncodingStrategy	getLongEncoding()
CompressionStrategy	getMetadataCompression()
CompressionStrategy	getMetricCompression()
SegmentizerFactory	getSegmentLoader()
StringColumnFormatSpec	getStringColumnFormatSpec()
StringEncodingStrategy	getStringDictionaryEncoding()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

IndexSpec

public IndexSpec(@Nullable
 BitmapSerdeFactory bitmapSerdeFactory,
 @Nullable
 CompressionStrategy metadataCompression,
 @Nullable
 CompressionStrategy dimensionCompression,
 @Nullable
 StringEncodingStrategy stringDictionaryEncoding,
 @Nullable
 CompressionStrategy metricCompression,
 @Nullable
 CompressionFactory.LongEncodingStrategy longEncoding,
 @Nullable
 CompressionStrategy complexMetricCompression,
 @Deprecated @Nullable
 CompressionStrategy jsonCompression,
 @Nullable
 SegmentizerFactory segmentLoader,
 @Nullable
 NestedCommonFormatColumnFormatSpec autoColumnFormatSpec,
 @Nullable
 StringColumnFormatSpec stringColumnFormatSpec)

Creates an IndexSpec with the given storage format settings.

Parameters:

bitmapSerdeFactory - type of bitmap to use (e.g. roaring or concise), null to use the default. Defaults to the bitmap type specified by the (deprecated) "druid.processing.bitmap.type" setting, or, if none was set, uses the default defined in BitmapSerde upon calling getEffectiveSpec()

metadataCompression - compression format for v10 metadata

dimensionCompression - compression format for dimension columns, null to use the default. Defaults to CompressionStrategy.DEFAULT_COMPRESSION_STRATEGY upon calling getEffectiveSpec()

stringDictionaryEncoding - encoding strategy for string dictionaries of dictionary encoded string columns

metricCompression - compression format for primitive type metric columns, null to use the default. Defaults to CompressionStrategy.DEFAULT_COMPRESSION_STRATEGY upon calling getEffectiveSpec().

longEncoding - encoding strategy for metric and dimension columns with type long, null to use the default. Defaults to CompressionFactory.DEFAULT_LONG_ENCODING_STRATEGY upon calling getEffectiveSpec()

complexMetricCompression - default CompressionStrategy to use for complex type columns which use generic serializers. Defaults to null which means no compression upon calling getEffectiveSpec().

jsonCompression - deprecated mechanism to define default json column 'raw' storage compression. This has been replaced by autoColumnFormatSpec which has NestedCommonFormatColumnFormatSpec.getObjectStorageCompression(). If this is set and autoColumnFormatSpec is null, this value will be used to set the object storage compression of the computed autoColumnFormatSpec upon calling getEffectiveSpec()

segmentLoader - specify a SegmentizerFactory which will be written to 'factory.json' and used to load the written segment

autoColumnFormatSpec - specify the default NestedCommonFormatColumnFormatSpec to use for json and auto columns. Defaults to null upon calling getEffectiveSpec().

stringColumnFormatSpec - specify the default StringColumnFormatSpec to use for string columns. Defaults to null upon calling getEffectiveSpec().

Method Details

getDefault

public static IndexSpec getDefault()

builder

public static IndexSpec.Builder builder()

getBitmapSerdeFactory

@Nullable
public BitmapSerdeFactory getBitmapSerdeFactory()

getMetadataCompression

@Nullable
public CompressionStrategy getMetadataCompression()

getDimensionCompression

@Nullable
public CompressionStrategy getDimensionCompression()

getStringDictionaryEncoding

@Nullable
public StringEncodingStrategy getStringDictionaryEncoding()

getMetricCompression

@Nullable
public CompressionStrategy getMetricCompression()

getLongEncoding

@Nullable
public CompressionFactory.LongEncodingStrategy getLongEncoding()

getComplexMetricCompression

@Nullable
public CompressionStrategy getComplexMetricCompression()

getSegmentLoader

@Nullable
public SegmentizerFactory getSegmentLoader()

getJsonCompression

@Deprecated
@Nullable
public CompressionStrategy getJsonCompression()

Deprecated.

getAutoColumnFormatSpec

@Nullable
public NestedCommonFormatColumnFormatSpec getAutoColumnFormatSpec()

getStringColumnFormatSpec

@Nullable
public StringColumnFormatSpec getStringColumnFormatSpec()

getEffectiveSpec

public IndexSpec getEffectiveSpec()

Populate all null fields of IndexSpec, first from getDefault() and finally falling back to hard coded defaults if no overrides are defined.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object