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 by SearchScript which can provided an Explanation of the score This is currently not used inside elasticsearch but it is used, see for example here: https://github.com/elastic/elasticsearch/issues/8561
FilterScript.Factory	A factory to construct stateful FilterScript factories for a specific index.
FilterScript.LeafFactory	A factory to construct FilterScript instances.
ScriptEngine	A script language implementation.
SearchScript.Factory	A factory to construct stateful SearchScript factories for a specific index.
SearchScript.LeafFactory	A factory to construct SearchScript 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.
ScoreAccessor	A float encapsulation that dynamically accesses the score of a document.
Script	Script represents used-defined input that can be used to compile and execute a script from the ScriptService based on the ScriptType.
ScriptContext<FactoryType>	The information necessary to compile and run a script.
ScriptMetaData	ScriptMetaData is used to store user-defined scripts as part of the ClusterState using only an id as the key.
ScriptMetaData.Builder	A builder used to modify the currently stored scripts data held within the ClusterState.
ScriptMetrics
ScriptModule	Manages building ScriptService.
ScriptService
ScriptStats
SearchScript	A generic script used for per document use cases.
SimilarityScript	A script that is used to build ScriptedSimilarity 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 the ClusterState.
TemplateScript	A string template rendered as a script.

Enum Summary

Enum	Description
ScriptType	ScriptType represents the way a script is stored and retrieved from the ScriptService.

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.