Class MapperService

    • Field Detail


        public static final java.lang.String SINGLE_MAPPING_NAME
        See Also:
        Constant Field Values

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

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

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

        public static final boolean INDEX_MAPPER_DYNAMIC_DEFAULT
        See Also:
        Constant Field Values

        public static final Setting<java.lang.Boolean> INDEX_MAPPER_DYNAMIC_SETTING
    • Method Detail

      • hasNested

        public boolean hasNested()
      • allEnabled

        public boolean allEnabled()
        Returns true if the "_all" field is enabled on any type.
      • docMappers

        public java.lang.Iterable<DocumentMapper> docMappers​(boolean includingDefaultMapping)
        returns an immutable iterator over current document mappers.
        includingDefaultMapping - indicates whether the iterator should contain the DEFAULT_MAPPING document mapper. As is this not really an active type, you would typically set this to false
      • getNamedAnalyzer

        public NamedAnalyzer getNamedAnalyzer​(java.lang.String analyzerName)
      • parseMapping

        public static java.util.Map<java.lang.String,​java.lang.Object> parseMapping​(NamedXContentRegistry xContentRegistry,
                                                                                          java.lang.String mappingSource)
                                                                                   throws java.lang.Exception
        Parses the mappings (formatted as JSON) into a map
      • updateMapping

        public boolean updateMapping​(IndexMetaData currentIndexMetaData,
                                     IndexMetaData newIndexMetaData)
        Update mapping by only merging the metadata that is different between received and stored entries
      • merge

        public void merge​(java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.Object>> mappings,
                          MapperService.MergeReason reason,
                          boolean updateAllTypes)
      • hasMapping

        public boolean hasMapping​(java.lang.String mappingType)
      • types

        public java.util.Collection<java.lang.String> types()
        Return the set of concrete types that have a mapping. NOTE: this does not return the default mapping.
      • 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.
      • 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)
      • fullName

        public MappedFieldType fullName​(java.lang.String fullName)
        Returns the MappedFieldType for the give fullName. If multiple types have fields with the same full name, the first is returned.
      • simpleMatchToFullName

        public java.util.Collection<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()
      • getParentTypes

        public java.util.Set<java.lang.String> getParentTypes()
      • close

        public void close()
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface
      • isMetadataField

        public static boolean isMetadataField​(java.lang.String fieldName)
        Whether a field is a metadata field.
      • getAllMetaFields

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

        public org.apache.lucene.index.Term createUidTerm​(java.lang.String type,
                                                          java.lang.String id)
        Return a term that uniquely identifies the document, or null if the type is not allowed.