Package org.elasticsearch.index.mapper

Class MapperService

java.lang.Object
org.elasticsearch.index.AbstractIndexComponent
org.elasticsearch.index.mapper.MapperService
All Implemented Interfaces:
Closeable, AutoCloseable, IndexComponent
public class MapperService extends AbstractIndexComponent implements Closeable

  • Field Details

    • DEFAULT_MAPPING

      public static final String DEFAULT_MAPPING
      See Also:
      Constant Field Values

    • SINGLE_MAPPING_NAME

      public static final String SINGLE_MAPPING_NAME
      See Also:
      Constant Field Values

    • INDEX_MAPPING_NESTED_FIELDS_LIMIT_SETTING

      public static final Setting<Long> INDEX_MAPPING_NESTED_FIELDS_LIMIT_SETTING

    • INDEX_MAPPING_NESTED_DOCS_LIMIT_SETTING

      public static final Setting<Long> INDEX_MAPPING_NESTED_DOCS_LIMIT_SETTING

    • INDEX_MAPPING_TOTAL_FIELDS_LIMIT_SETTING

      public static final Setting<Long> INDEX_MAPPING_TOTAL_FIELDS_LIMIT_SETTING

    • INDEX_MAPPING_DEPTH_LIMIT_SETTING

      public static final Setting<Long> INDEX_MAPPING_DEPTH_LIMIT_SETTING

    • INDEX_MAPPING_FIELD_NAME_LENGTH_LIMIT_SETTING

      public static final Setting<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<Boolean> INDEX_MAPPER_DYNAMIC_SETTING
      Deprecated.

    • META_FIELDS_BEFORE_7DOT8

      @Deprecated public static final Set<String> META_FIELDS_BEFORE_7DOT8
      Deprecated.

  • Constructor Details

  • Method Details

    • hasNested

      public boolean hasNested()

    • getIndexAnalyzers

      public IndexAnalyzers getIndexAnalyzers()

    • getNamedAnalyzer

      public NamedAnalyzer getNamedAnalyzer(String analyzerName)

    • parserContext

      public MappingParserContext parserContext()

    • documentParser

      public DocumentParser documentParser()
      Exposes a DocumentParser
      Returns:
      a document parser to be used to parse incoming documents

    • parseMapping

      public static Map<String,Object> parseMapping(org.elasticsearch.common.xcontent.NamedXContentRegistry xContentRegistry, String mappingSource) throws IOException
      Parses the mappings (formatted as JSON) into a map
      Throws:
      IOException

    • updateMapping

      public void updateMapping(IndexMetadata currentIndexMetadata, IndexMetadata newIndexMetadata) throws IOException
      Update local mapping by applying the incoming mapping that have already been merged with the current one on the master
      Throws:
      IOException

    • merge

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

    • merge

      public void merge(String type, Map<String,Object> mappings, MapperService.MergeReason reason) throws IOException
      Throws:
      IOException

    • merge

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

    • merge

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

    • parseMapping

      public Mapping parseMapping(String type, CompressedXContent mappingSource, boolean applyDefault)

    • mergeMappings

      public static Mapping mergeMappings(DocumentMapper currentMapper, Mapping incomingMapping, MapperService.MergeReason reason)

    • documentMapper

      public DocumentMapper documentMapper()
      Return the document mapper, or null if no mapping has been put yet or no documents have been indexed in the current index yet (which triggers a dynamic mapping update)

    • documentMapper

      public DocumentMapper documentMapper(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(String type, Map<String,Object> mapping)
      Returns true if the given mappingSource includes a type as a top-level object.

    • isMappingSourceTyped

      public static boolean isMappingSourceTyped(String type, CompressedXContent mappingSource)

    • getTypeForUpdate

      public String getTypeForUpdate(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 String resolveDocumentType(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.

    • fieldType

      public MappedFieldType fieldType(String fullName)
      Given the full name of a field, returns its MappedFieldType.

    • mappingLookup

      public MappingLookup mappingLookup()
      Exposes a snapshot of the mappings for the current index. If no mappings have been registered for the current index, an empty MappingLookup instance is returned. An index does not have mappings only if it was created without providing mappings explicitly, and no documents have yet been indexed in it.

    • getEagerGlobalOrdinalsFields

      public Iterable<MappedFieldType> getEagerGlobalOrdinalsFields()
      Returns all mapped field types.

    • indexAnalyzer

      public NamedAnalyzer indexAnalyzer(String field, Function<String,NamedAnalyzer> unindexedFieldAnalyzer)
      Return the index-time analyzer associated with a particular field
      Parameters:
      field - the field name
      unindexedFieldAnalyzer - a function to return an Analyzer for a field with no directly associated index-time analyzer

    • close

      public void close() throws IOException
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Throws:
      IOException

    • isMetadataField

      public boolean isMetadataField(String field)
      Returns:
      Whether a field is a metadata field. this method considers all mapper plugins

    • reloadSearchAnalyzers

      public List<String> reloadSearchAnalyzers(AnalysisRegistry registry) throws IOException
      Throws:
      IOException