forked from opensearch-project/OpenSearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DerivedField] Support DerivedField object type and integration with …
…Mapper (opensearch-project#13720) * Support DerivedField object type * ValueFetcher for DerivedField of object type to parse and fetch nested fields. * DerivedFieldResolver to resolve DerivedField type on the fly. * Introduction of new support types - text, float. * Use index analyzer for derived fields set in index settings. * Support of derived fields from query string * Unit tests Signed-off-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * Derived field object type properties to also support Object as a value Signed-off-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * Index and cluster setting to control derived fields Signed-off-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * Fix test Signed-off-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * Fixed missing javadoc Signed-off-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * Fix the rewrite issue when profile is set as true Signed-off-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * Address PR comments Signed-off-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * Address PR comments Signed-off-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * Use conjuction query with filter on source_indexed_field query and DerivedFieldQuery Signed-off-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * support source_indexed_field for non-object type derived fields Signed-off-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * rename source_indexed_field to prefilter_field Signed-off-by: Rishabh Maurya <rishabhmaurya05@gmail.com> --------- Signed-off-by: Rishabh Maurya <rishabhmaurya05@gmail.com>
- Loading branch information
1 parent
0ddf4bd
commit 9da6170
Showing
30 changed files
with
2,736 additions
and
320 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
229 changes: 229 additions & 0 deletions
229
server/src/main/java/org/opensearch/index/mapper/DefaultDerivedFieldResolver.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,229 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.index.mapper; | ||
|
|
||
| import org.apache.logging.log4j.LogManager; | ||
| import org.apache.logging.log4j.Logger; | ||
| import org.opensearch.common.regex.Regex; | ||
| import org.opensearch.index.query.QueryShardContext; | ||
| import org.opensearch.script.Script; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.HashMap; | ||
| import java.util.HashSet; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
| import java.util.Optional; | ||
| import java.util.Set; | ||
| import java.util.concurrent.ConcurrentHashMap; | ||
|
|
||
| import static org.opensearch.index.mapper.FieldMapper.IGNORE_MALFORMED_SETTING; | ||
|
|
||
| /** | ||
| * Accepts definition of DerivedField from search request in both forms: map parsed from SearchRequest and {@link DerivedField} defined using client. | ||
| * The object is initialized per search request and is responsible to resolve {@link DerivedFieldType} given a field name. | ||
| * It uses {@link FieldTypeInference} to infer field type for a nested field within DerivedField of {@link DerivedFieldSupportedTypes#OBJECT} type. | ||
| */ | ||
| public class DefaultDerivedFieldResolver implements DerivedFieldResolver { | ||
| private final QueryShardContext queryShardContext; | ||
| private final Map<String, DerivedFieldType> derivedFieldTypeMap = new ConcurrentHashMap<>(); | ||
| private final FieldTypeInference typeInference; | ||
| private static final Logger logger = LogManager.getLogger(DefaultDerivedFieldResolver.class); | ||
|
|
||
| DefaultDerivedFieldResolver( | ||
| QueryShardContext queryShardContext, | ||
| Map<String, Object> derivedFieldsObject, | ||
| List<DerivedField> derivedFields | ||
| ) { | ||
| this( | ||
| queryShardContext, | ||
| derivedFieldsObject, | ||
| derivedFields, | ||
| new FieldTypeInference( | ||
| queryShardContext.index().getName(), | ||
| queryShardContext.getMapperService(), | ||
| queryShardContext.getIndexReader() | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| DefaultDerivedFieldResolver( | ||
| QueryShardContext queryShardContext, | ||
| Map<String, Object> derivedFieldsObject, | ||
| List<DerivedField> derivedFields, | ||
| FieldTypeInference typeInference | ||
| ) { | ||
| this.queryShardContext = queryShardContext; | ||
| initDerivedFieldTypes(derivedFieldsObject, derivedFields); | ||
| this.typeInference = typeInference; | ||
| } | ||
|
|
||
| @Override | ||
| public Set<String> resolvePattern(String pattern) { | ||
| Set<String> derivedFields = new HashSet<>(); | ||
| if (queryShardContext != null && queryShardContext.getMapperService() != null) { | ||
| for (MappedFieldType fieldType : queryShardContext.getMapperService().fieldTypes()) { | ||
| if (Regex.simpleMatch(pattern, fieldType.name()) && fieldType instanceof DerivedFieldType) { | ||
| derivedFields.add(fieldType.name()); | ||
| } | ||
| } | ||
| } | ||
| for (String fieldName : derivedFieldTypeMap.keySet()) { | ||
| if (Regex.simpleMatch(pattern, fieldName)) { | ||
| derivedFields.add(fieldName); | ||
| } | ||
| } | ||
| return derivedFields; | ||
| } | ||
|
|
||
| /** | ||
| * Resolves the fieldName. The search request definitions are given precedence over derived fields definitions in the index mapping. | ||
| * It caches the response for previously resolved field names | ||
| * @param fieldName name of the field. It also accepts nested derived field | ||
| * @return DerivedFieldType if resolved successfully, a null otherwise. | ||
| */ | ||
| @Override | ||
| public DerivedFieldType resolve(String fieldName) { | ||
| return Optional.ofNullable(resolveUsingSearchDefinitions(fieldName)).orElseGet(() -> resolveUsingMappings(fieldName)); | ||
| } | ||
|
|
||
| private DerivedFieldType resolveUsingSearchDefinitions(String fieldName) { | ||
| return Optional.ofNullable(derivedFieldTypeMap.get(fieldName)) | ||
| .orElseGet( | ||
| () -> Optional.ofNullable((DerivedFieldType) getParentDerivedField(fieldName)) | ||
| .map( | ||
| // compute and cache nested derived field | ||
| parentDerivedField -> derivedFieldTypeMap.computeIfAbsent( | ||
| fieldName, | ||
| f -> this.resolveNestedField(f, parentDerivedField) | ||
| ) | ||
| ) | ||
| .orElse(null) | ||
| ); | ||
| } | ||
|
|
||
| private DerivedFieldType resolveNestedField(String fieldName, DerivedFieldType parentDerivedField) { | ||
| Objects.requireNonNull(parentDerivedField); | ||
| try { | ||
| Script script = parentDerivedField.derivedField.getScript(); | ||
| String nestedType = explicitTypeFromParent(parentDerivedField.derivedField, fieldName.substring(fieldName.indexOf(".") + 1)); | ||
| if (nestedType == null) { | ||
| Mapper inferredFieldMapper = typeInference.infer( | ||
| getValueFetcher(fieldName, script, parentDerivedField.derivedField.getIgnoreMalformed()) | ||
| ); | ||
| if (inferredFieldMapper != null) { | ||
| nestedType = inferredFieldMapper.typeName(); | ||
| } | ||
| } | ||
| if (nestedType != null) { | ||
| DerivedField derivedField = new DerivedField(fieldName, nestedType, script); | ||
| if (parentDerivedField.derivedField.getProperties() != null) { | ||
| derivedField.setProperties(parentDerivedField.derivedField.getProperties()); | ||
| } | ||
| if (parentDerivedField.derivedField.getPrefilterField() != null) { | ||
| derivedField.setPrefilterField(parentDerivedField.derivedField.getPrefilterField()); | ||
| } | ||
| if (parentDerivedField.derivedField.getFormat() != null) { | ||
| derivedField.setFormat(parentDerivedField.derivedField.getFormat()); | ||
| } | ||
| if (parentDerivedField.derivedField.getIgnoreMalformed()) { | ||
| derivedField.setIgnoreMalformed(parentDerivedField.derivedField.getIgnoreMalformed()); | ||
| } | ||
| return getDerivedFieldType(derivedField); | ||
| } else { | ||
| logger.warn( | ||
| "Field type cannot be inferred. Ensure the field {} is not rare across entire index or provide explicit mapping using [properties] under parent object [{}] ", | ||
| fieldName, | ||
| parentDerivedField.derivedField.getName() | ||
| ); | ||
| } | ||
| } catch (IOException e) { | ||
| logger.warn(e.getMessage()); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| private MappedFieldType getParentDerivedField(String fieldName) { | ||
| if (fieldName.contains(".")) { | ||
| return resolve(fieldName.split("\\.")[0]); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| private static String explicitTypeFromParent(DerivedField parentDerivedField, String subField) { | ||
| if (parentDerivedField == null) { | ||
| return null; | ||
| } | ||
| return parentDerivedField.getNestedFieldType(subField); | ||
| } | ||
|
|
||
| ValueFetcher getValueFetcher(String fieldName, Script script, boolean ignoreMalformed) { | ||
| String subFieldName = fieldName.substring(fieldName.indexOf(".") + 1); | ||
| return new ObjectDerivedFieldType.ObjectDerivedFieldValueFetcher( | ||
| subFieldName, | ||
| DerivedFieldType.getDerivedFieldLeafFactory(script, queryShardContext, queryShardContext.lookup()), | ||
| o -> o, // raw object returned will be used to infer the type without modifying it | ||
| ignoreMalformed | ||
| ); | ||
| } | ||
|
|
||
| private void initDerivedFieldTypes(Map<String, Object> derivedFieldsObject, List<DerivedField> derivedFields) { | ||
| if (derivedFieldsObject != null && !derivedFieldsObject.isEmpty()) { | ||
| Map<String, Object> derivedFieldObject = new HashMap<>(); | ||
| derivedFieldObject.put(DerivedFieldMapper.CONTENT_TYPE, derivedFieldsObject); | ||
| derivedFieldTypeMap.putAll(getAllDerivedFieldTypeFromObject(derivedFieldObject)); | ||
| } | ||
| if (derivedFields != null) { | ||
| for (DerivedField derivedField : derivedFields) { | ||
| derivedFieldTypeMap.put(derivedField.getName(), getDerivedFieldType(derivedField)); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private Map<String, DerivedFieldType> getAllDerivedFieldTypeFromObject(Map<String, Object> derivedFieldObject) { | ||
| Map<String, DerivedFieldType> derivedFieldTypes = new HashMap<>(); | ||
| DocumentMapper documentMapper = queryShardContext.getMapperService() | ||
| .documentMapperParser() | ||
| .parse(DerivedFieldMapper.CONTENT_TYPE, derivedFieldObject); | ||
| if (documentMapper != null && documentMapper.mappers() != null) { | ||
| for (Mapper mapper : documentMapper.mappers()) { | ||
| if (mapper instanceof DerivedFieldMapper) { | ||
| DerivedFieldType derivedFieldType = ((DerivedFieldMapper) mapper).fieldType(); | ||
| derivedFieldTypes.put(derivedFieldType.name(), derivedFieldType); | ||
| } | ||
| } | ||
| } | ||
| return derivedFieldTypes; | ||
| } | ||
|
|
||
| private DerivedFieldType getDerivedFieldType(DerivedField derivedField) { | ||
| Mapper.BuilderContext builderContext = new Mapper.BuilderContext( | ||
| queryShardContext.getMapperService().getIndexSettings().getSettings(), | ||
| new ContentPath(1) | ||
| ); | ||
| DerivedFieldMapper.Builder builder = new DerivedFieldMapper.Builder( | ||
| derivedField, | ||
| queryShardContext.getMapperService().getIndexAnalyzers(), | ||
| null, | ||
| IGNORE_MALFORMED_SETTING.getDefault(queryShardContext.getIndexSettings().getSettings()) | ||
| ); | ||
| return builder.build(builderContext).fieldType(); | ||
| } | ||
|
|
||
| private DerivedFieldType resolveUsingMappings(String name) { | ||
| if (queryShardContext != null && queryShardContext.getMapperService() != null) { | ||
| MappedFieldType mappedFieldType = queryShardContext.getMapperService().fieldType(name); | ||
| if (mappedFieldType instanceof DerivedFieldType) { | ||
| return (DerivedFieldType) mappedFieldType; | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.