mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-04-03 22:08:34 +00:00
a4060f7436
This removes all the mentions of the sandbox from the script engine services and permissions model. This means that the following settings are no longer supported: ```yaml script.inline: sandbox script.stored: sandbox ``` Instead, only a `true` or `false` value can be specified. Since this would otherwise break the default-allow parameter for languages like expressions, painless, and mustache, all script engines have been updated to have individual settings, for instance: ```yaml script.engine.groovy.inline: true ``` Would enable all inline scripts for groovy. (they can still be overridden on a per-operation basis). Expressions, Painless, and Mustache all default to `true` for inline, file, and stored scripts to preserve the old scripting behavior. Resolves #17114
88 lines
2.4 KiB
Plaintext
88 lines
2.4 KiB
Plaintext
[[modules-scripting]]
|
|
== Scripting
|
|
|
|
The scripting module enables you to use scripts to evaluate custom
|
|
expressions. For example, you could use a script to return "script fields"
|
|
as part of a search request or evaluate a custom score for a query.
|
|
|
|
TIP: Elasticsearch now has a built-in scripting language called _Painless_
|
|
that provides a more secure alternative for implementing
|
|
scripts for Elasticsearch. We encourage you to try it out --
|
|
for more information, see <<modules-scripting-painless, Painless Scripting Language>>.
|
|
|
|
The default scripting language is http://groovy-lang.org/[groovy].
|
|
Additional `lang` plugins enable you to run scripts written in other languages.
|
|
Everywhere a script can be used, you can include a `lang` parameter
|
|
to specify the language of the script.
|
|
|
|
[float]
|
|
=== General-purpose languages:
|
|
|
|
These languages can be used for any purpose in the scripting APIs,
|
|
and give the most flexibility.
|
|
|
|
[cols="<,<,<",options="header",]
|
|
|=======================================================================
|
|
|Language
|
|
|Required plugin
|
|
|
|
|<<modules-scripting-painless, `painless`>>
|
|
|built-in
|
|
|
|
|<<modules-scripting-groovy, `groovy`>>
|
|
|built-in
|
|
|
|
|{plugins}/lang-javascript.html[`javascript`]
|
|
|{plugins}/lang-javascript.html[`lang-javascript`]
|
|
|
|
|{plugins}/lang-python.html[`python`]
|
|
|{plugins}/lang-python.html[`lang-python`]
|
|
|
|
|=======================================================================
|
|
|
|
[float]
|
|
=== Special-purpose languages:
|
|
|
|
These languages are less flexible, but typically have higher performance for
|
|
certain tasks.
|
|
|
|
[cols="<,<,<,<",options="header",]
|
|
|=======================================================================
|
|
|Language
|
|
|Required plugin
|
|
|Purpose
|
|
|
|
|<<modules-scripting-expression, `expression`>>
|
|
|built-in
|
|
|fast custom ranking and sorting
|
|
|
|
|<<search-template, `mustache`>>
|
|
|built-in
|
|
|templates
|
|
|
|
|<<modules-scripting-native, `java`>>
|
|
|you write it!
|
|
|expert API
|
|
|
|
|=======================================================================
|
|
|
|
=================================================
|
|
|
|
|
|
include::scripting/using.asciidoc[]
|
|
|
|
include::scripting/fields.asciidoc[]
|
|
|
|
include::scripting/security.asciidoc[]
|
|
|
|
include::scripting/groovy.asciidoc[]
|
|
|
|
include::scripting/painless.asciidoc[]
|
|
|
|
include::scripting/expression.asciidoc[]
|
|
|
|
include::scripting/native.asciidoc[]
|
|
|
|
include::scripting/advanced-scripting.asciidoc[]
|
|
|