Package org.elasticsearch.script
Support for running user provided scripts (in the request, in cluster state, etc) in portions of various requests
(
FunctionScoreQuery
, Aggregation
,
UpdateAction
, etc). Pluggable via implementing ScriptPlugin
.-
Interface Summary Interface Description ExecutableScript An executable script, can't be used concurrently.ExecutableScript.Factory ExplainableSearchScript To be implemented bySearchScript
which can provided anExplanation
of the score This is currently not used inside elasticsearch but it is used, see for example here: https://github.com/elastic/elasticsearch/issues/8561FilterScript.Factory A factory to construct statefulFilterScript
factories for a specific index.FilterScript.LeafFactory A factory to constructFilterScript
instances.IngestScript.Factory ScoreScript.Factory A factory to construct statefulScoreScript
factories for a specific index.ScoreScript.LeafFactory A factory to constructScoreScript
instances.ScriptedMetricAggContexts.CombineScript.Factory ScriptedMetricAggContexts.InitScript.Factory ScriptedMetricAggContexts.MapScript.Factory ScriptedMetricAggContexts.MapScript.LeafFactory ScriptedMetricAggContexts.ReduceScript.Factory ScriptEngine A script language implementation.SearchScript.Factory A factory to construct statefulSearchScript
factories for a specific index.SearchScript.LeafFactory A factory to constructSearchScript
instances.SimilarityScript.Factory SimilarityWeightScript.Factory TemplateScript.Factory -
Class Summary Class Description ClassPermission Checked by scripting engines to allow loading a java class.FilterScript A script implementation of a query filter.IngestScript A script used by the Ingest Script Processor.ScoreAccessor A float encapsulation that dynamically accesses the score of a document.ScoreScript A script used for adjusting the score on a per document basis.Script Script
represents used-defined input that can be used to compile and execute a script from theScriptService
based on theScriptType
.ScriptContext<FactoryType> The information necessary to compile and run a script.ScriptedMetricAggContexts ScriptedMetricAggContexts.CombineScript ScriptedMetricAggContexts.InitScript ScriptedMetricAggContexts.MapScript ScriptedMetricAggContexts.ReduceScript ScriptMetaData ScriptMetaData
is used to store user-defined scripts as part of theClusterState
using only an id as the key.ScriptMetaData.Builder A builder used to modify the currently stored scripts data held within theClusterState
.ScriptMetrics ScriptModule Manages buildingScriptService
.ScriptService ScriptStats SearchScript A generic script used for per document use cases.SimilarityScript A script that is used to buildScriptedSimilarity
instances.SimilarityWeightScript A script that is used to compute scoring factors that are the same for all documents.StoredScriptSource StoredScriptSource
represents user-defined parameters for a script saved in theClusterState
.TemplateScript A string template rendered as a script. -
Enum Summary Enum Description ScriptType ScriptType represents the way a script is stored and retrieved from theScriptService
. -
Exception Summary Exception Description GeneralScriptException Deprecated. Use ScriptException for exceptions from the scripting engine, otherwise use a more appropriate exception (e.g.ScriptException Exception from a scripting engine.