Disallow multiple parent-join fields per mapping #25002
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,132 @@ | ||
| /* | ||
| * 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.join.mapper; | ||
|
|
||
| import org.apache.lucene.index.IndexOptions; | ||
| import org.apache.lucene.index.IndexableField; | ||
| import org.apache.lucene.util.BytesRef; | ||
| import org.elasticsearch.common.settings.Settings; | ||
| import org.elasticsearch.index.fielddata.IndexFieldData; | ||
| import org.elasticsearch.index.fielddata.plain.DocValuesIndexFieldData; | ||
| import org.elasticsearch.index.mapper.FieldMapper; | ||
| import org.elasticsearch.index.mapper.MappedFieldType; | ||
| import org.elasticsearch.index.mapper.ParseContext; | ||
| import org.elasticsearch.index.mapper.StringFieldType; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.List; | ||
|
|
||
| /** | ||
| * Simple field mapper hack to ensure that there is a one and only {@link ParentJoinFieldMapper} per mapping. | ||
| * This field mapper is not used to index or query any data, it is used as a marker in the mapping that | ||
| * denotes the presence of a parent-join field and forbids the addition of any additional ones. | ||
| * This class is also used to quickly retrieve the parent-join field defined in a mapping without | ||
| * specifying the name of the field. | ||
| */ | ||
| class MetaJoinFieldMapper extends FieldMapper { | ||
| static final String NAME = "_parent_join"; | ||
| static final String CONTENT_TYPE = "parent_join"; | ||
|
|
||
| static class Defaults { | ||
| public static final MappedFieldType FIELD_TYPE = new MetaJoinFieldType(); | ||
|
|
||
| static { | ||
| FIELD_TYPE.setStored(false); | ||
| FIELD_TYPE.setHasDocValues(false); | ||
| FIELD_TYPE.setIndexOptions(IndexOptions.NONE); | ||
| FIELD_TYPE.freeze(); | ||
| } | ||
| } | ||
|
|
||
| static class Builder extends FieldMapper.Builder<Builder, MetaJoinFieldMapper> { | ||
| Builder() { | ||
| super(NAME, Defaults.FIELD_TYPE, Defaults.FIELD_TYPE); | ||
| builder = this; | ||
| } | ||
|
|
||
| @Override | ||
| public MetaJoinFieldMapper build(BuilderContext context) { | ||
| fieldType.setName(NAME); | ||
| return new MetaJoinFieldMapper(name, fieldType, context.indexSettings()); | ||
| } | ||
| } | ||
|
|
||
| static final class MetaJoinFieldType extends StringFieldType { | ||
| ParentJoinFieldMapper mapper; | ||
|
|
||
| MetaJoinFieldType() {} | ||
|
|
||
| protected MetaJoinFieldType(MetaJoinFieldType ref) { | ||
| super(ref); | ||
| } | ||
|
|
||
| public MetaJoinFieldType clone() { | ||
| return new MetaJoinFieldType(this); | ||
| } | ||
|
|
||
| @Override | ||
| public String typeName() { | ||
| return CONTENT_TYPE; | ||
| } | ||
|
|
||
| @Override | ||
| public IndexFieldData.Builder fielddataBuilder() { | ||
| failIfNoDocValues(); | ||
| return new DocValuesIndexFieldData.Builder(); | ||
| } | ||
|
|
||
| @Override | ||
| public Object valueForDisplay(Object value) { | ||
| if (value == null) { | ||
| return null; | ||
| } | ||
| BytesRef binaryValue = (BytesRef) value; | ||
| return binaryValue.utf8ToString(); | ||
| } | ||
| } | ||
|
|
||
| MetaJoinFieldMapper(String name, MappedFieldType fieldType, Settings indexSettings) { | ||
| super(name, fieldType, ParentIdFieldMapper.Defaults.FIELD_TYPE, indexSettings, MultiFields.empty(), null); | ||
| } | ||
|
|
||
| void setFieldMapper(ParentJoinFieldMapper mapper) { | ||
| fieldType().mapper = mapper; | ||
| } | ||
|
|
||
| @Override | ||
| public MetaJoinFieldType fieldType() { | ||
| return (MetaJoinFieldType) super.fieldType(); | ||
| } | ||
|
|
||
| @Override | ||
| protected MetaJoinFieldMapper clone() { | ||
| return (MetaJoinFieldMapper) super.clone(); | ||
| } | ||
|
|
||
| @Override | ||
| protected void parseCreateField(ParseContext context, List<IndexableField> fields) throws IOException { | ||
| throw new IllegalStateException("Should never be called"); | ||
| } | ||
|
|
||
| @Override | ||
| protected String contentType() { | ||
| return CONTENT_TYPE; | ||
| } | ||
| } |
This file contains hidden or 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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 (I added the same method here locally (differently implemented) )