org.elasticsearch.script.ScriptedMetricAggContexts Maven / Gradle / Ivy

Go to download
/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.script;

import org.apache.lucene.index.LeafReaderContext;
import org.apache.lucene.search.Scorable;
import org.elasticsearch.ElasticsearchException;
import org.elasticsearch.common.logging.DeprecationCategory;
import org.elasticsearch.common.logging.DeprecationLogger;
import org.elasticsearch.index.fielddata.ScriptDocValues;
import org.elasticsearch.search.lookup.SearchLookup;
import org.elasticsearch.search.lookup.SourceLookup;

import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.function.Function;

public class ScriptedMetricAggContexts {

    public abstract static class InitScript {
        private final Map params;
        private final Map state;

        public InitScript(Map params, Map state) {
            this.params = params;
            this.state = state;
        }

        public Map getParams() {
            return params;
        }

        public Object getState() {
            return state;
        }

        public abstract void execute();

        public interface Factory extends ScriptFactory {
            InitScript newInstance(Map params, Map state);
        }

        public static String[] PARAMETERS = {};
        public static ScriptContext CONTEXT = new ScriptContext<>("aggs_init", Factory.class);
    }

    public abstract static class MapScript extends DocBasedScript {

        private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(DynamicMap.class);
        private static final Map> PARAMS_FUNCTIONS = org.elasticsearch.core.Map.of("doc", value -> {
            deprecationLogger.warn(
                DeprecationCategory.SCRIPTING,
                "map-script_doc",
                "Accessing variable [doc] via [params.doc] from within an scripted metric agg map script "
                    + "is deprecated in favor of directly accessing [doc]."
            );
            return value;
        }, "_doc", value -> {
            deprecationLogger.warn(
                DeprecationCategory.SCRIPTING,
                "map-script__doc",
                "Accessing variable [doc] via [params._doc] from within an scripted metric agg map script "
                    + "is deprecated in favor of directly accessing [doc]."
            );
            return value;
        }, "_agg", value -> {
            deprecationLogger.warn(
                DeprecationCategory.SCRIPTING,
                "map-script__agg",
                "Accessing variable [_agg] via [params._agg] from within a scripted metric agg map script "
                    + "is deprecated in favor of using [state]."
            );
            return value;
        }, "_source", value -> ((SourceLookup) value).source());

        private final Map params;
        private final Map state;
        private Scorable scorer;

        public MapScript(Map params, Map state, SearchLookup lookup, LeafReaderContext leafContext) {
            super(leafContext == null ? null : new DocValuesDocReader(lookup, leafContext));
            this.state = state;
            params = new HashMap<>(params); // copy params so we aren't modifying input
            params.putAll(docAsMap()); // add lookup vars
            this.params = new DynamicMap(params, PARAMS_FUNCTIONS); // wrap with deprecations
        }

        public Map getParams() {
            return params;
        }

        public Map getState() {
            return state;
        }

        // Override this to ensure null is returned for backcompat rather than an empty map.
        public Map> getDoc() {
            return docReader == null ? null : docReader.doc();
        }

        public void setScorer(Scorable scorer) {
            this.scorer = scorer;
        }

        // get_score() is named this way so that it's picked up by Painless as '_score'
        public double get_score() {
            if (scorer == null) {
                return 0.0;
            }

            try {
                return scorer.score();
            } catch (IOException e) {
                throw new ElasticsearchException("Couldn't look up score", e);
            }
        }

        public abstract void execute();

        public interface LeafFactory {
            MapScript newInstance(LeafReaderContext ctx);
        }

        public interface Factory extends ScriptFactory {
            LeafFactory newFactory(Map params, Map state, SearchLookup lookup);
        }

        public static String[] PARAMETERS = new String[] {};
        public static ScriptContext CONTEXT = new ScriptContext<>("aggs_map", Factory.class);
    }

    public abstract static class CombineScript {
        private final Map params;
        private final Map state;

        public CombineScript(Map params, Map state) {
            this.params = params;
            this.state = state;
        }

        public Map getParams() {
            return params;
        }

        public Map getState() {
            return state;
        }

        public abstract Object execute();

        public interface Factory extends ScriptFactory {
            CombineScript newInstance(Map params, Map state);
        }

        public static String[] PARAMETERS = {};
        public static ScriptContext CONTEXT = new ScriptContext<>("aggs_combine", Factory.class);
    }

    public abstract static class ReduceScript {
        private final Map params;
        private final List