SCRIPTING: Move Aggregation Script Context to its own class #33820
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -110,8 +110,4 @@ public double runAsDouble() { | |
| return ((Number)run()).doubleValue(); | ||
| } | ||
|
|
||
| } | ||
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,165 @@ | ||
| /* | ||
| * 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.script; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import org.apache.lucene.index.LeafReaderContext; | ||
| import org.apache.lucene.search.Scorable; | ||
| import org.elasticsearch.ElasticsearchException; | ||
| import org.elasticsearch.common.lucene.ScorerAware; | ||
| import org.elasticsearch.index.fielddata.ScriptDocValues; | ||
| import org.elasticsearch.search.lookup.LeafSearchLookup; | ||
| import org.elasticsearch.search.lookup.SearchLookup; | ||
|
|
||
| public abstract class AggregationScript implements ScorerAware { | ||
|
|
||
| public static final String[] PARAMETERS = {}; | ||
|
|
||
| public static final ScriptContext<Factory> CONTEXT = new ScriptContext<>("aggs", Factory.class); | ||
|
|
||
| private static final Map<String, String> DEPRECATIONS; | ||
|
|
||
| static { | ||
| Map<String, String> deprecations = new HashMap<>(); | ||
| deprecations.put( | ||
| "doc", | ||
| "Accessing variable [doc] via [params.doc] from within an aggregation-script " + | ||
| "is deprecated in favor of directly accessing [doc]." | ||
| ); | ||
| deprecations.put( | ||
| "_doc", | ||
| "Accessing variable [doc] via [params._doc] from within an aggregation-script " + | ||
| "is deprecated in favor of directly accessing [doc]." | ||
| ); | ||
| DEPRECATIONS = Collections.unmodifiableMap(deprecations); | ||
| } | ||
|
|
||
| /** | ||
| * The generic runtime parameters for the script. | ||
| */ | ||
| private final Map<String, Object> params; | ||
|
|
||
| /** | ||
| * A leaf lookup for the bound segment this script will operate on. | ||
| */ | ||
| private final LeafSearchLookup leafLookup; | ||
|
|
||
| /** | ||
| * A scorer that will return the score for the current document when the script is run. | ||
| */ | ||
| protected Scorable scorer; | ||
|
|
||
| private Object value; | ||
|
|
||
| public AggregationScript(Map<String, Object> params, SearchLookup lookup, LeafReaderContext leafContext) { | ||
| this.params = new ParameterMap(new HashMap<>(params), DEPRECATIONS); | ||
| this.leafLookup = lookup.getLeafSearchLookup(leafContext); | ||
| this.params.putAll(leafLookup.asMap()); | ||
| } | ||
|
|
||
| /** | ||
| * Return the parameters for this script. | ||
| */ | ||
| public Map<String, Object> getParams() { | ||
| return params; | ||
| } | ||
|
|
||
| /** | ||
| * The doc lookup for the Lucene segment this script was created for. | ||
| */ | ||
| public Map<String, ScriptDocValues<?>> getDoc() { | ||
| return leafLookup.doc(); | ||
| } | ||
|
|
||
| /** | ||
| * Set the current document to run the script on next. | ||
| */ | ||
| public void setDocument(int docid) { | ||
| leafLookup.setDocument(docid); | ||
| } | ||
|
|
||
| @Override | ||
| public void setScorer(Scorable scorer) { | ||
| this.scorer = scorer; | ||
| } | ||
|
|
||
| /** Return the score of the current document. */ | ||
| public double getScore() { | ||
|
There was a problem hiding this comment. I don't think we should have score accessible as There was a problem hiding this comment. That's what I was going to ask you, but yea I think |
||
| try { | ||
| return scorer == null ? 0.0 : scorer.score(); | ||
| } catch (IOException e) { | ||
| throw new ElasticsearchException("couldn't lookup score", e); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Sets per-document aggregation {@code _value}. | ||
| * <p> | ||
| * The default implementation just calls {@code setNextVar("_value", value)} but | ||
| * some engines might want to handle this differently for better performance. | ||
| * <p> | ||
| * @param value per-document value, typically a String, Long, or Double | ||
| */ | ||
| public void setNextAggregationValue(Object value) { | ||
|
There was a problem hiding this comment. At minimum this should be typed (we should have separate script classes for each underlying doc values type), but I would much rather this be built into the script itself, so instead of setting the value, an iterate type call is made, similar to the doc values api. There was a problem hiding this comment. @rjernst as it turns out this isn't so trivial :( Determining the exact type of the script upstream would require a lot of refactoring starting with |
||
| this.value = value; | ||
| } | ||
|
|
||
| public Number get_score() { | ||
| return getScore(); | ||
| } | ||
|
|
||
| public Object get_value() { | ||
| return value; | ||
| } | ||
|
|
||
| /** | ||
| * Return the result as a long. This is used by aggregation scripts over long fields. | ||
| */ | ||
| public long runAsLong() { | ||
|
There was a problem hiding this comment. We shouldn't need these methods if we make typed versions of scripts, where execute would then return the correct type. Additionally, don't we always return double for all numeric fields (ie runAsLong isn't actually used)? There was a problem hiding this comment. It's used in: |
||
| return ((Number) execute()).longValue(); | ||
| } | ||
|
|
||
| public double runAsDouble() { | ||
| return ((Number) execute()).doubleValue(); | ||
| } | ||
|
|
||
| public abstract Object execute(); | ||
|
|
||
| /** | ||
| * A factory to construct {@link AggregationScript} instances. | ||
| */ | ||
| public interface LeafFactory { | ||
| AggregationScript newInstance(LeafReaderContext ctx) throws IOException; | ||
|
|
||
| /** | ||
| * Return {@code true} if the script needs {@code _score} calculated, or {@code false} otherwise. | ||
| */ | ||
| boolean needs_score(); | ||
| } | ||
|
|
||
| /** | ||
| * A factory to construct stateful {@link AggregationScript} factories for a specific index. | ||
| */ | ||
| public interface Factory { | ||
| LeafFactory newFactory(Map<String, Object> params, SearchLookup lookup); | ||
| } | ||
| } | ||
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.
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 didn't think
docor_scoreworks in value aggregation scripts? Looking at the user of this, I don't see where setDocument is called.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 don't know about the score (though a scorer is set for this script in e.g
org.elasticsearch.search.aggregations.support.values.ScriptBytesValues#setScorer) but the document is set in many places likeorg.elasticsearch.search.aggregations.support.values.ScriptLongValues#advanceExactThere 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.
Thanks, I see the calls to setDocument now. It still looks like the scorer is not set anywhere, but it also looks quite deceptive so I fear there is something more complex going on.