-
Notifications
You must be signed in to change notification settings - Fork 25.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add basic support for field aliases in index mappings. (#31287)
* Add basic support for field aliases through a new top-level mapper type. * Add tests for queries, aggregations, sorting, and fetching doc values. * Make sure we properly handle wildcard fields in query string queries. * Allow for aliases when requesting suggestions. * Allow for aliases when requesting highlights. * Add a test for field capabilities.
- Loading branch information
1 parent
6371d51
commit f545589
Showing
27 changed files
with
1,285 additions
and
60 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
127 changes: 127 additions & 0 deletions
127
server/src/main/java/org/elasticsearch/index/mapper/FieldAliasMapper.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,127 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.elasticsearch.index.mapper; | ||
|
|
||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
| import org.elasticsearch.common.xcontent.support.XContentMapValues; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Collections; | ||
| import java.util.Iterator; | ||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * A mapper for field aliases. | ||
| * | ||
| * A field alias has no concrete field mappings of its own, but instead points to another field by | ||
| * its path. Once defined, an alias can be used in place of the concrete field name in search requests. | ||
| */ | ||
| public final class FieldAliasMapper extends Mapper { | ||
| public static final String CONTENT_TYPE = "alias"; | ||
|
|
||
| public static class Names { | ||
| public static final String PATH = "path"; | ||
| } | ||
|
|
||
| private final String name; | ||
| private final String path; | ||
|
|
||
| public FieldAliasMapper(String simpleName, | ||
| String name, | ||
| String path) { | ||
| super(simpleName); | ||
| this.name = name; | ||
| this.path = path; | ||
| } | ||
|
|
||
| @Override | ||
| public String name() { | ||
| return name; | ||
| } | ||
|
|
||
| public String path() { | ||
| return path; | ||
| } | ||
|
|
||
| @Override | ||
| public Mapper merge(Mapper mergeWith) { | ||
| if (!(mergeWith instanceof FieldAliasMapper)) { | ||
| throw new IllegalArgumentException("Cannot merge a field alias mapping [" | ||
| + name() + "] with a mapping that is not for a field alias."); | ||
| } | ||
| return mergeWith; | ||
| } | ||
|
|
||
| @Override | ||
| public Mapper updateFieldType(Map<String, MappedFieldType> fullNameToFieldType) { | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| public Iterator<Mapper> iterator() { | ||
| return Collections.emptyIterator(); | ||
| } | ||
|
|
||
| @Override | ||
| public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { | ||
| return builder.startObject(simpleName()) | ||
| .field("type", CONTENT_TYPE) | ||
| .field(Names.PATH, path) | ||
| .endObject(); | ||
| } | ||
|
|
||
| public static class TypeParser implements Mapper.TypeParser { | ||
| @Override | ||
| public Mapper.Builder parse(String name, Map<String, Object> node, ParserContext parserContext) | ||
| throws MapperParsingException { | ||
| FieldAliasMapper.Builder builder = new FieldAliasMapper.Builder(name); | ||
| Object pathField = node.remove(Names.PATH); | ||
| String path = XContentMapValues.nodeStringValue(pathField, null); | ||
| if (path == null) { | ||
| throw new MapperParsingException("The [path] property must be specified for field [" + name + "]."); | ||
| } | ||
| return builder.path(path); | ||
| } | ||
| } | ||
|
|
||
| public static class Builder extends Mapper.Builder<FieldAliasMapper.Builder, FieldAliasMapper> { | ||
| private String name; | ||
| private String path; | ||
|
|
||
| protected Builder(String name) { | ||
| super(name); | ||
| this.name = name; | ||
| } | ||
|
|
||
| public String name() { | ||
| return this.name; | ||
| } | ||
|
|
||
| public Builder path(String path) { | ||
| this.path = path; | ||
| return this; | ||
| } | ||
|
|
||
| public FieldAliasMapper build(BuilderContext context) { | ||
| String fullName = context.path().pathAsText(name); | ||
| return new FieldAliasMapper(name, fullName, path); | ||
| } | ||
| } | ||
| } |
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
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
Oops, something went wrong.