forked from elastic/elasticsearch
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added
has_parent filter (elastic#2243)
The `has_parent` filter accepts a query and a parent type. The query is executed in the parent document space, which is specified by the parent type. This filter return child documents which associated parents have matched. For the rest `has_parent` filter has the same options and works in the same manner as the `has_child` filter.
This is an experimental filter.
Filter example
###################
```
{
"has_parent" : {
"parent_type" : "blog"
"query" : {
"term" : {
"tag" : "something"
}
}
}
}
```
The `parent_type` field name can also be abbreviated to `type`.
Memory considerations
###############
With the current implementation, all _id values are loaded to memory (heap) in order to support fast lookups, so make sure there is enough mem for it.
This issue originates from issue elastic#792- Loading branch information
Showing
11 changed files
with
651 additions
and
15 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
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
84 changes: 84 additions & 0 deletions
84
src/main/java/org/elasticsearch/index/query/HasParentFilterBuilder.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,84 @@ | ||
| /* | ||
| * Licensed to ElasticSearch and Shay Banon 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.query; | ||
|
|
||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| /** | ||
| * Builder for the 'has_parent' filter. | ||
| */ | ||
| public class HasParentFilterBuilder extends BaseFilterBuilder { | ||
|
|
||
| private final QueryBuilder queryBuilder; | ||
| private final String parentType; | ||
| private String scope; | ||
| private String filterName; | ||
| private String executionType; | ||
|
|
||
| /** | ||
| * @param parentType The parent type | ||
| * @param parentQuery The query that will be matched with parent documents | ||
| */ | ||
| public HasParentFilterBuilder(String parentType, QueryBuilder parentQuery) { | ||
| this.parentType = parentType; | ||
| this.queryBuilder = parentQuery; | ||
| } | ||
|
|
||
| public HasParentFilterBuilder scope(String scope) { | ||
| this.scope = scope; | ||
| return this; | ||
| } | ||
|
|
||
| public HasParentFilterBuilder filterName(String filterName) { | ||
| this.filterName = filterName; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Expert: Sets the low level parent to child filtering implementation. Can be: 'indirect' or 'uid' | ||
| * | ||
| * This option is experimental and will be removed. | ||
| */ | ||
| public HasParentFilterBuilder executionType(String executionType) { | ||
| this.executionType = executionType; | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| protected void doXContent(XContentBuilder builder, Params params) throws IOException { | ||
| builder.startObject(HasParentFilterParser.NAME); | ||
| builder.field("query"); | ||
| queryBuilder.toXContent(builder, params); | ||
| builder.field("parent_type", parentType); | ||
| if (scope != null) { | ||
| builder.field("_scope", scope); | ||
| } | ||
| if (filterName != null) { | ||
| builder.field("_name", filterName); | ||
| } | ||
| if (executionType != null) { | ||
| builder.field("execution_type", executionType); | ||
| } | ||
| builder.endObject(); | ||
| } | ||
| } | ||
|
|
126 changes: 126 additions & 0 deletions
126
src/main/java/org/elasticsearch/index/query/HasParentFilterParser.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,126 @@ | ||
| /* | ||
| * Licensed to ElasticSearch and Shay Banon 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.query; | ||
|
|
||
| import org.apache.lucene.search.Filter; | ||
| import org.apache.lucene.search.FilteredQuery; | ||
| import org.apache.lucene.search.Query; | ||
| import org.elasticsearch.common.Strings; | ||
| import org.elasticsearch.common.inject.Inject; | ||
| import org.elasticsearch.common.xcontent.XContentParser; | ||
| import org.elasticsearch.index.mapper.DocumentMapper; | ||
| import org.elasticsearch.index.mapper.FieldMapper; | ||
| import org.elasticsearch.index.mapper.internal.ParentFieldMapper; | ||
| import org.elasticsearch.index.search.child.HasParentFilter; | ||
| import org.elasticsearch.search.internal.SearchContext; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| /** | ||
| * | ||
| */ | ||
| public class HasParentFilterParser implements FilterParser { | ||
|
|
||
| public static final String NAME = "has_parent"; | ||
|
|
||
| @Inject | ||
| public HasParentFilterParser() { | ||
| } | ||
|
|
||
| @Override | ||
| public String[] names() { | ||
| return new String[]{NAME, Strings.toCamelCase(NAME)}; | ||
| } | ||
|
|
||
| @Override | ||
| public Filter parse(QueryParseContext parseContext) throws IOException, QueryParsingException { | ||
| XContentParser parser = parseContext.parser(); | ||
|
|
||
| Query query = null; | ||
| boolean queryFound = false; | ||
| String parentType = null; | ||
| String executionType = "uid"; | ||
| String scope = null; | ||
|
|
||
| String filterName = null; | ||
| String currentFieldName = null; | ||
| XContentParser.Token token; | ||
| while ((token = parser.nextToken()) != XContentParser.Token.END_OBJECT) { | ||
| if (token == XContentParser.Token.FIELD_NAME) { | ||
| currentFieldName = parser.currentName(); | ||
| } else if (token == XContentParser.Token.START_OBJECT) { | ||
| if ("query".equals(currentFieldName)) { | ||
| // TODO handle `query` element before `type` element... | ||
| String[] origTypes = QueryParseContext.setTypesWithPrevious(parentType == null ? null : new String[]{parentType}); | ||
| try { | ||
| query = parseContext.parseInnerQuery(); | ||
| queryFound = true; | ||
| } finally { | ||
| QueryParseContext.setTypes(origTypes); | ||
| } | ||
| } else { | ||
| throw new QueryParsingException(parseContext.index(), "[has_parent] filter does not support [" + currentFieldName + "]"); | ||
| } | ||
| } else if (token.isValue()) { | ||
| if ("type".equals(currentFieldName) || "parent_type".equals(currentFieldName) || "parentType".equals(currentFieldName)) { | ||
| parentType = parser.text(); | ||
| } else if ("_scope".equals(currentFieldName)) { | ||
| scope = parser.text(); | ||
| } else if ("_name".equals(currentFieldName)) { | ||
| filterName = parser.text(); | ||
| // TODO: change to execution_type | ||
| } else if ("execution_type".equals(currentFieldName) || "executionType".equals(currentFieldName)) { // This option is experimental and will most likely be removed. | ||
| executionType = parser.text(); | ||
| } else { | ||
| throw new QueryParsingException(parseContext.index(), "[has_parent] filter does not support [" + currentFieldName + "]"); | ||
| } | ||
| } | ||
| } | ||
| if (!queryFound) { | ||
| throw new QueryParsingException(parseContext.index(), "[parent] filter requires 'query' field"); | ||
| } | ||
| if (query == null) { | ||
| return null; | ||
| } | ||
|
|
||
| if (parentType == null) { | ||
| throw new QueryParsingException(parseContext.index(), "[parent] filter requires 'parent_type' field"); | ||
| } | ||
|
|
||
| DocumentMapper parentDocMapper = parseContext.mapperService().documentMapper(parentType); | ||
| if (parentDocMapper == null) { | ||
| throw new QueryParsingException(parseContext.index(), "[parent] filter configured 'parent_type' [" + parentType + "] is not a valid type"); | ||
| } | ||
|
|
||
| // wrap the query with type query | ||
| query = new FilteredQuery(query, parseContext.cacheFilter(parentDocMapper.typeFilter(), null)); | ||
|
|
||
| SearchContext searchContext = SearchContext.current(); | ||
|
|
||
| HasParentFilter parentFilter = HasParentFilter.create(executionType, query, scope, parentType, searchContext); | ||
| searchContext.addScopePhase(parentFilter); | ||
|
|
||
| if (filterName != null) { | ||
| parseContext.addNamedFilter(filterName, parentFilter); | ||
| } | ||
| return parentFilter; | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.