org.elasticsearch.index.codec

Class CodecService

java.lang.Object

org.elasticsearch.index.AbstractIndexComponent

org.elasticsearch.index.codec.CodecService

All Implemented Interfaces:

IndexComponent

public class CodecService
extends AbstractIndexComponent

Since Lucene 4.0 low level index segments are read and written through a codec layer that allows to use use-case specific file formats & data-structures per field. Elasticsearch exposes the full Codec capabilities through this CodecService.

See Also:

PostingsFormatService, DocValuesFormatService

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CODEC

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

componentSettings, index, indexSettings, logger

Constructor Summary

Constructors

Constructor and Description
CodecService(Index index)
CodecService(Index index, Settings indexSettings)
CodecService(Index index, Settings indexSettings, PostingsFormatService postingsFormatService, DocValuesFormatService docValuesFormatService, MapperService mapperService)

Method Summary

Modifier and Type	Method and Description
String[]	availableCodecs() Returns all registered available codec names
org.apache.lucene.codecs.Codec	codec(String name)
DocValuesFormatService	docValuesFormatService()
MapperService	mapperService()
PostingsFormatService	postingsFormatService()

Methods inherited from class org.elasticsearch.index.AbstractIndexComponent

index, nodeName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CODEC

public static final String DEFAULT_CODEC

See Also:

Constant Field Values

Constructor Detail

CodecService

public CodecService(Index index)

CodecService

public CodecService(Index index,
                    @IndexSettings
                    Settings indexSettings)

CodecService

@Inject
public CodecService(Index index,
                            @IndexSettings
                            Settings indexSettings,
                            PostingsFormatService postingsFormatService,
                            DocValuesFormatService docValuesFormatService,
                            MapperService mapperService)

Method Detail

postingsFormatService

public PostingsFormatService postingsFormatService()

docValuesFormatService

public DocValuesFormatService docValuesFormatService()

mapperService

public MapperService mapperService()

codec

public org.apache.lucene.codecs.Codec codec(String name)
                                     throws ElasticsearchIllegalArgumentException

Throws:

ElasticsearchIllegalArgumentException

availableCodecs

public String[] availableCodecs()

Returns all registered available codec names