Package org.apache.pinot.spi.config.table

Class FieldConfig

java.lang.Object

org.apache.pinot.spi.config.BaseJsonConfig

org.apache.pinot.spi.config.table.FieldConfig

All Implemented Interfaces:

Serializable

public class FieldConfig
extends BaseJsonConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FieldConfig.CompressionCodec
static class	FieldConfig.EncodingType
static class	FieldConfig.IndexType

Field Summary

Fields

Modifier and Type	Field	Description
static String	BLOOM_FILTER_COLUMN_KEY
static String	DEFAULT_FORWARD_INDEX_DISABLED
static String	DERIVE_NUM_DOCS_PER_CHUNK_RAW_INDEX_KEY
static String	FORWARD_INDEX_DISABLED
static String	IS_SEGMENT_PARTITIONED_COLUMN_KEY
static String	ON_HEAP_DICTIONARY_COLUMN_KEY
static String	RAW_INDEX_WRITER_VERSION
static String	TEXT_FST_TYPE
static String	TEXT_INDEX_DEFAULT_RAW_VALUE
static String	TEXT_INDEX_ENABLE_QUERY_CACHE
static String	TEXT_INDEX_NO_RAW_DATA
static String	TEXT_INDEX_RAW_VALUE
static String	TEXT_INDEX_REALTIME_READER_REFRESH_KEY
static String	TEXT_INDEX_STOP_WORD_EXCLUDE_KEY
static String	TEXT_INDEX_STOP_WORD_INCLUDE_KEY
static String	TEXT_INDEX_STOP_WORD_SEPERATOR
static String	TEXT_INDEX_USE_AND_FOR_MULTI_TERM_QUERIES
static String	TEXT_NATIVE_FST_LITERAL
static String	VAR_LENGTH_DICTIONARY_COLUMN_KEY

Constructor Summary

Constructors

Constructor	Description
FieldConfig(String name, FieldConfig.EncodingType encodingType, List<FieldConfig.IndexType> indexTypes, FieldConfig.CompressionCodec compressionCodec, Map<String,String> properties)
FieldConfig(String name, FieldConfig.EncodingType encodingType, FieldConfig.IndexType indexType, List<FieldConfig.IndexType> indexTypes, FieldConfig.CompressionCodec compressionCodec, TimestampConfig timestampConfig, Map<String,String> properties)
FieldConfig(String name, FieldConfig.EncodingType encodingType, FieldConfig.IndexType indexType, FieldConfig.CompressionCodec compressionCodec, Map<String,String> properties)	Deprecated.

Method Summary

Modifier and Type	Method	Description
FieldConfig.CompressionCodec	getCompressionCodec()
FieldConfig.EncodingType	getEncodingType()
FieldConfig.IndexType	getIndexType()	Deprecated.
List<FieldConfig.IndexType>	getIndexTypes()
String	getName()
Map<String,String>	getProperties()
TimestampConfig	getTimestampConfig()

Methods inherited from class org.apache.pinot.spi.config.BaseJsonConfig

equals, hashCode, toJsonNode, toJsonString, toString

Methods inherited from class java.lang.Object

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

Field Detail

BLOOM_FILTER_COLUMN_KEY

public static final String BLOOM_FILTER_COLUMN_KEY

See Also:

Constant Field Values

ON_HEAP_DICTIONARY_COLUMN_KEY

public static final String ON_HEAP_DICTIONARY_COLUMN_KEY

See Also:

Constant Field Values

VAR_LENGTH_DICTIONARY_COLUMN_KEY

public static final String VAR_LENGTH_DICTIONARY_COLUMN_KEY

See Also:

Constant Field Values

DERIVE_NUM_DOCS_PER_CHUNK_RAW_INDEX_KEY

public static final String DERIVE_NUM_DOCS_PER_CHUNK_RAW_INDEX_KEY

See Also:

Constant Field Values

RAW_INDEX_WRITER_VERSION

public static final String RAW_INDEX_WRITER_VERSION

See Also:

Constant Field Values

IS_SEGMENT_PARTITIONED_COLUMN_KEY

public static final String IS_SEGMENT_PARTITIONED_COLUMN_KEY

See Also:

Constant Field Values

TEXT_INDEX_REALTIME_READER_REFRESH_KEY

public static final String TEXT_INDEX_REALTIME_READER_REFRESH_KEY

See Also:

Constant Field Values

TEXT_INDEX_ENABLE_QUERY_CACHE

public static final String TEXT_INDEX_ENABLE_QUERY_CACHE

See Also:

Constant Field Values

TEXT_INDEX_USE_AND_FOR_MULTI_TERM_QUERIES

public static final String TEXT_INDEX_USE_AND_FOR_MULTI_TERM_QUERIES

See Also:

Constant Field Values

TEXT_INDEX_NO_RAW_DATA

public static final String TEXT_INDEX_NO_RAW_DATA

See Also:

Constant Field Values

TEXT_INDEX_RAW_VALUE

public static final String TEXT_INDEX_RAW_VALUE

See Also:

Constant Field Values

TEXT_INDEX_DEFAULT_RAW_VALUE

public static final String TEXT_INDEX_DEFAULT_RAW_VALUE

See Also:

Constant Field Values

TEXT_INDEX_STOP_WORD_INCLUDE_KEY

public static final String TEXT_INDEX_STOP_WORD_INCLUDE_KEY

See Also:

Constant Field Values

TEXT_INDEX_STOP_WORD_EXCLUDE_KEY

public static final String TEXT_INDEX_STOP_WORD_EXCLUDE_KEY

See Also:

Constant Field Values

TEXT_INDEX_STOP_WORD_SEPERATOR

public static final String TEXT_INDEX_STOP_WORD_SEPERATOR

See Also:

Constant Field Values

TEXT_FST_TYPE

public static final String TEXT_FST_TYPE

See Also:

Constant Field Values

TEXT_NATIVE_FST_LITERAL

public static final String TEXT_NATIVE_FST_LITERAL

See Also:

Constant Field Values

FORWARD_INDEX_DISABLED

public static final String FORWARD_INDEX_DISABLED

See Also:

Constant Field Values

DEFAULT_FORWARD_INDEX_DISABLED

public static final String DEFAULT_FORWARD_INDEX_DISABLED

Constructor Detail

FieldConfig

@Deprecated
public FieldConfig(String name,
                   FieldConfig.EncodingType encodingType,
                   FieldConfig.IndexType indexType,
                   FieldConfig.CompressionCodec compressionCodec,
                   Map<String,String> properties)

Deprecated.

FieldConfig

public FieldConfig(String name,
                   FieldConfig.EncodingType encodingType,
                   List<FieldConfig.IndexType> indexTypes,
                   FieldConfig.CompressionCodec compressionCodec,
                   Map<String,String> properties)

FieldConfig

public FieldConfig(String name,
                   FieldConfig.EncodingType encodingType,
                   @Nullable
                   FieldConfig.IndexType indexType,
                   @Nullable
                   List<FieldConfig.IndexType> indexTypes,
                   @Nullable
                   FieldConfig.CompressionCodec compressionCodec,
                   @Nullable
                   TimestampConfig timestampConfig,
                   @Nullable
                   Map<String,String> properties)

Method Detail

getName

public String getName()

getEncodingType

public FieldConfig.EncodingType getEncodingType()

getIndexType

@Nullable
@Deprecated
public FieldConfig.IndexType getIndexType()

Deprecated.

getIndexTypes

public List<FieldConfig.IndexType> getIndexTypes()

getCompressionCodec

@Nullable
public FieldConfig.CompressionCodec getCompressionCodec()

getTimestampConfig

@Nullable
public TimestampConfig getTimestampConfig()

getProperties

@Nullable
public Map<String,String> getProperties()