Package org.elasticsearch.index.mapper

Class MapperService

java.lang.Object

org.elasticsearch.index.AbstractIndexComponent

org.elasticsearch.index.mapper.MapperService

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, IndexComponent

public class MapperService
extends AbstractIndexComponent
implements java.io.Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MapperService.MergeReason	The reason why a mapping is being merged.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_MAPPING
static boolean	INDEX_MAPPER_DYNAMIC_DEFAULT
static Setting<java.lang.Boolean>	INDEX_MAPPER_DYNAMIC_SETTING	Deprecated.
static Setting<java.lang.Long>	INDEX_MAPPING_DEPTH_LIMIT_SETTING
static Setting<java.lang.Long>	INDEX_MAPPING_FIELD_NAME_LENGTH_LIMIT_SETTING
static Setting<java.lang.Long>	INDEX_MAPPING_NESTED_DOCS_LIMIT_SETTING
static Setting<java.lang.Long>	INDEX_MAPPING_NESTED_FIELDS_LIMIT_SETTING
static Setting<java.lang.Long>	INDEX_MAPPING_TOTAL_FIELDS_LIMIT_SETTING
static java.lang.String	SINGLE_MAPPING_NAME

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

indexSettings, logger

Constructor Summary

Constructors

Constructor	Description
MapperService(IndexSettings indexSettings, IndexAnalyzers indexAnalyzers, org.elasticsearch.common.xcontent.NamedXContentRegistry xContentRegistry, SimilarityService similarityService, MapperRegistry mapperRegistry, java.util.function.Supplier<QueryShardContext> queryShardContextSupplier, java.util.function.BooleanSupplier idFieldDataEnabled)

Method Summary

Modifier and Type	Method	Description
void	close()
DocumentMapper	documentMapper()	Return the document mapper, or null if no mapping has been put yet.
DocumentMapper	documentMapper(java.lang.String type)	Return the DocumentMapper for the given type.
DocumentMapperParser	documentMapperParser()
DocumentMapperForType	documentMapperWithAutoCreate(java.lang.String type)	Returns the document mapper created, including a mapping update if the type has been dynamically created.
MappedFieldType	fieldType(java.lang.String fullName)	Given the full name of a field, returns its MappedFieldType.
java.lang.Iterable<MappedFieldType>	fieldTypes()	Returns all mapped field types.
static java.lang.String[]	getAllMetaFields()
IndexAnalyzers	getIndexAnalyzers()
NamedAnalyzer	getNamedAnalyzer(java.lang.String analyzerName)
ObjectMapper	getObjectMapper(java.lang.String name)
java.lang.String	getTypeForUpdate(java.lang.String type, CompressedXContent mappingSource)	If the _type name is _doc and there is no _doc top-level key then this means that we are handling a typeless call.
boolean	hasNested()
org.apache.lucene.analysis.Analyzer	indexAnalyzer()
boolean	isIdFieldDataEnabled()	Returns true if fielddata is enabled for the IdFieldMapper field, false otherwise.
static boolean	isMappingSourceTyped(java.lang.String type, java.util.Map<java.lang.String,java.lang.Object> mapping)	Returns true if the given mappingSource includes a type as a top-level object.
static boolean	isMappingSourceTyped(java.lang.String type, CompressedXContent mappingSource)
static boolean	isMetadataField(java.lang.String fieldName)
DocumentMapper	merge(java.lang.String type, CompressedXContent mappingSource, MapperService.MergeReason reason)
void	merge(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> mappings, MapperService.MergeReason reason)
void	merge(IndexMetadata indexMetadata, MapperService.MergeReason reason)
DocumentMapper	parse(java.lang.String mappingType, CompressedXContent mappingSource, boolean applyDefault)
static java.util.Map<java.lang.String,java.lang.Object>	parseMapping(org.elasticsearch.common.xcontent.NamedXContentRegistry xContentRegistry, java.lang.String mappingSource)	Parses the mappings (formatted as JSON) into a map
java.util.List<java.lang.String>	reloadSearchAnalyzers(AnalysisRegistry registry)
java.lang.String	resolveDocumentType(java.lang.String type)	Resolves a type from a mapping-related request into the type that should be used when merging and updating mappings.
org.apache.lucene.analysis.Analyzer	searchAnalyzer()
org.apache.lucene.analysis.Analyzer	searchQuoteAnalyzer()
java.util.Set<java.lang.String>	simpleMatchToFullName(java.lang.String pattern)	Returns all the fields that match the given pattern.
MappedFieldType	unmappedFieldType(java.lang.String type)	Given a type (eg.
boolean	updateMapping(IndexMetadata currentIndexMetadata, IndexMetadata newIndexMetadata)	Update mapping by only merging the metadata that is different between received and stored entries

Methods inherited from class org.elasticsearch.index.AbstractIndexComponent

getIndexSettings, index

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_MAPPING

public static final java.lang.String DEFAULT_MAPPING

See Also:

Constant Field Values

SINGLE_MAPPING_NAME

public static final java.lang.String SINGLE_MAPPING_NAME

See Also:

Constant Field Values

INDEX_MAPPING_NESTED_FIELDS_LIMIT_SETTING

public static final Setting<java.lang.Long> INDEX_MAPPING_NESTED_FIELDS_LIMIT_SETTING

INDEX_MAPPING_NESTED_DOCS_LIMIT_SETTING

public static final Setting<java.lang.Long> INDEX_MAPPING_NESTED_DOCS_LIMIT_SETTING

INDEX_MAPPING_TOTAL_FIELDS_LIMIT_SETTING

public static final Setting<java.lang.Long> INDEX_MAPPING_TOTAL_FIELDS_LIMIT_SETTING

INDEX_MAPPING_DEPTH_LIMIT_SETTING

public static final Setting<java.lang.Long> INDEX_MAPPING_DEPTH_LIMIT_SETTING

INDEX_MAPPING_FIELD_NAME_LENGTH_LIMIT_SETTING

public static final Setting<java.lang.Long> INDEX_MAPPING_FIELD_NAME_LENGTH_LIMIT_SETTING

INDEX_MAPPER_DYNAMIC_DEFAULT

public static final boolean INDEX_MAPPER_DYNAMIC_DEFAULT

See Also:

Constant Field Values

INDEX_MAPPER_DYNAMIC_SETTING

@Deprecated public static final Setting<java.lang.Boolean> INDEX_MAPPER_DYNAMIC_SETTING

Deprecated.

Constructor Details

MapperService

public MapperService(IndexSettings indexSettings, IndexAnalyzers indexAnalyzers, org.elasticsearch.common.xcontent.NamedXContentRegistry xContentRegistry, SimilarityService similarityService, MapperRegistry mapperRegistry, java.util.function.Supplier<QueryShardContext> queryShardContextSupplier, java.util.function.BooleanSupplier idFieldDataEnabled)

Method Details

hasNested

public boolean hasNested()

getIndexAnalyzers

public IndexAnalyzers getIndexAnalyzers()

getNamedAnalyzer

public NamedAnalyzer getNamedAnalyzer(java.lang.String analyzerName)

documentMapperParser

public DocumentMapperParser documentMapperParser()

parseMapping

public static java.util.Map<java.lang.String,java.lang.Object> parseMapping(org.elasticsearch.common.xcontent.NamedXContentRegistry xContentRegistry, java.lang.String mappingSource) throws java.lang.Exception

Parses the mappings (formatted as JSON) into a map

Throws:

java.lang.Exception

updateMapping

public boolean updateMapping(IndexMetadata currentIndexMetadata, IndexMetadata newIndexMetadata) throws java.io.IOException

Update mapping by only merging the metadata that is different between received and stored entries

Throws:

java.io.IOException

merge

public void merge(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> mappings, MapperService.MergeReason reason)

merge

public void merge(IndexMetadata indexMetadata, MapperService.MergeReason reason)

merge

public DocumentMapper merge(java.lang.String type, CompressedXContent mappingSource, MapperService.MergeReason reason)

parse

public DocumentMapper parse(java.lang.String mappingType, CompressedXContent mappingSource, boolean applyDefault) throws MapperParsingException

Throws:

MapperParsingException

documentMapper

public DocumentMapper documentMapper()

Return the document mapper, or null if no mapping has been put yet.

documentMapper

public DocumentMapper documentMapper(java.lang.String type)

Return the DocumentMapper for the given type. By using the special "_default_" type, you can get a DocumentMapper for the default mapping.

isMappingSourceTyped

public static boolean isMappingSourceTyped(java.lang.String type, java.util.Map<java.lang.String,java.lang.Object> mapping)

Returns true if the given mappingSource includes a type as a top-level object.

isMappingSourceTyped

public static boolean isMappingSourceTyped(java.lang.String type, CompressedXContent mappingSource)

getTypeForUpdate

public java.lang.String getTypeForUpdate(java.lang.String type, CompressedXContent mappingSource)

If the _type name is _doc and there is no _doc top-level key then this means that we are handling a typeless call. In such a case, we override _doc with the actual type name in the mappings. This allows to use typeless APIs on typed indices.

resolveDocumentType

public java.lang.String resolveDocumentType(java.lang.String type)

Resolves a type from a mapping-related request into the type that should be used when merging and updating mappings. If the special `_doc` type is provided, then we replace it with the actual type that is being used in the mappings. This allows typeless APIs such as 'index' or 'put mappings' to work against indices with a custom type name.

documentMapperWithAutoCreate

public DocumentMapperForType documentMapperWithAutoCreate(java.lang.String type)

Returns the document mapper created, including a mapping update if the type has been dynamically created.

fieldType

public MappedFieldType fieldType(java.lang.String fullName)

Given the full name of a field, returns its MappedFieldType.

simpleMatchToFullName

public java.util.Set<java.lang.String> simpleMatchToFullName(java.lang.String pattern)

Returns all the fields that match the given pattern. If the pattern is prefixed with a type then the fields will be returned with a type prefix.

fieldTypes

public java.lang.Iterable<MappedFieldType> fieldTypes()

Returns all mapped field types.

getObjectMapper

public ObjectMapper getObjectMapper(java.lang.String name)

unmappedFieldType

public MappedFieldType unmappedFieldType(java.lang.String type)

Given a type (eg. long, string, ...), return an anonymous field mapper that can be used for search operations.

indexAnalyzer

public org.apache.lucene.analysis.Analyzer indexAnalyzer()

searchAnalyzer

public org.apache.lucene.analysis.Analyzer searchAnalyzer()

searchQuoteAnalyzer

public org.apache.lucene.analysis.Analyzer searchQuoteAnalyzer()

isIdFieldDataEnabled

public boolean isIdFieldDataEnabled()

Returns true if fielddata is enabled for the IdFieldMapper field, false otherwise.

close

public void close() throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

isMetadataField

public static boolean isMetadataField(java.lang.String fieldName)

Returns:

Whether a field is a metadata field.

getAllMetaFields

public static java.lang.String[] getAllMetaFields()

reloadSearchAnalyzers

public java.util.List<java.lang.String> reloadSearchAnalyzers(AnalysisRegistry registry) throws java.io.IOException

Throws:

java.io.IOException