Package org.elasticsearch.script
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
.-
InterfaceDescriptionA factory to construct stateful
AggregationScript
factories for a specific index.A factory to constructAggregationScript
instances.Converts between one scriptingField
type and another,FC
, with a different underlying value type,TC
.Access the document in a script, provides both old-style, doc['fieldname'], and new style field('fieldname') access to the fields.To be implemented byScoreScript
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/8561A factory to constructFieldScript
instances.FieldValues<T>The underlying contents of a scripting Field.A factory to construct statefulFilterScript
factories for a specific index.A factory to constructFilterScript
instances.Provides direct access to a LeafReaderContextA factory to construct statefulNumberSortScript
factories for a specific index.A factory to constructNumberSortScript
instances.A factory to construct statefulScoreScript
factories for a specific index.A factory to constructScoreScript
instances.Takes a Script definition and returns a compiled script factoryA script language implementation.Contains utility methods for compiled scripts without impacting concrete script signaturesA factory to construct statefulStringSortScript
factories for a specific index.A factory to constructStringSortScript
instances.A factory to construct statefulTermsSetQueryScript
factories for a specific index.A factory to constructTermsSetQueryScript
instances. -
ClassDescriptionAbstract base for scripts to execute to build scripted fields.Common base class for script field scripts that return long values.A script used in bucket aggregations that returns a
double
value.A script used in bucket aggregations that returns aboolean
value.Checked by scripting engines to allow loading a java class.A script that emits a map of multiple values, that can then be accessed by child runtime fields.Converters
for scripting fields.Helper for creatingConverter
classes which delegates all un-overridden methods to the underlyingFieldValues
.Temporary parse method that takes into account the date format.Provide access to DocValues for scriptfield
api anddoc
API.DynamicMap is used to wrap a Map for a script parameter.EmptyField<T>Script field with no mapping, always returnsdefaultValue
.Field<T>A field in a document accessible via scripting.A script to produce dynamic values for return fields.A script implementation of a query filter.Script producing geo points.A script used byConditionalProcessor
.A script used by the Ingest Script Processor.Script producing IP addresses.A wrapper around ZonedDateTime that exposes joda methods for backcompat.A script used for adjusting the score on a per document basis.A helper to take in an explanation from a script and turn it into anExplanation
Script
represents used-defined input that can be used to compile and execute a script from theScriptService
based on theScriptType
.Script cache and compilation rate limiter.ScriptContext<FactoryType>The information necessary to compile and run a script.The allowable types, languages and their corresponding contexts.ScriptMetadata
is used to store user-defined scripts as part of theClusterState
using only an id as the key.A builder used to modify the currently stored scripts data held within theClusterState
.Manages buildingScriptService
.A script used in significant terms heuristic scoring.A script that is used to buildScriptedSimilarity
instances.A script that is used to compute scoring factors that are the same for all documents.StoredScriptSource
represents user-defined parameters for a script saved in theClusterState
.A string template rendered as a script.An update script. -
Enum ClassDescriptionScriptType represents the way a script is stored and retrieved from the
ScriptService
. -
ExceptionDescriptionDeprecated.Use ScriptException for exceptions from the scripting engine, otherwise use a more appropriate exception (e.g.A failed conversion of a script
Field
.Exception from a scripting engine.