2016-03-18 17:07:43 -04:00
[[modules-scripting-painless]]
2016-05-04 12:17:10 -04:00
=== Painless Scripting Language
2016-03-18 17:07:43 -04:00
2016-03-24 13:34:23 -04:00
experimental[The Painless scripting language is new and is still marked as experimental. The syntax or API may be changed in the future in non-backwards compatible ways if required.]
2016-05-04 12:17:10 -04:00
_Painless_ is a simple, secure scripting language available in Elasticsearch
by default. It is designed specifically for use with Elasticsearch and can
safely be used with `inline` and `stored` scripting, which is enabled by
default.
2016-03-18 17:07:43 -04:00
2016-06-24 12:06:41 -04:00
The Painless syntax is similar to http://groovy-lang.org/index.html[Groovy].
2016-03-18 17:07:43 -04:00
2017-01-26 10:39:19 -05:00
You can use Painless anywhere a script can be used in Elasticsearch. It is the
default if you don't set the `lang` parameter but if you want to be explicit you
can set the `lang` parameter to `painless`.
2016-03-18 17:07:43 -04:00
[[painless-features]]
[float]
2016-03-24 13:34:23 -04:00
== Painless Features
2016-03-18 17:07:43 -04:00
2016-06-24 12:06:41 -04:00
* Fast performance: https://benchmarks.elastic.co/index.html#search_qps_scripts[several times faster] than the alternatives.
2016-03-18 17:07:43 -04:00
2017-01-26 10:39:19 -05:00
* Safety: Fine-grained whitelist with method call/field granularity. See
<<painless-api-reference>> for a complete list of available classes and methods.
2016-03-18 17:07:43 -04:00
2016-06-24 12:06:41 -04:00
* Optional typing: Variables and parameters can use explicit types or the dynamic `def` type.
2016-03-18 17:07:43 -04:00
2016-06-24 12:06:41 -04:00
* Syntax: Extends Java's syntax with a subset of Groovy for ease of use. See the <<modules-scripting-painless-syntax, Syntax Overview>>.
2016-06-13 21:42:37 -04:00
2016-06-24 12:06:41 -04:00
* Optimizations: Designed specifically for Elasticsearch scripting.
2016-03-18 17:07:43 -04:00
[[painless-examples]]
[float]
2016-03-24 13:34:23 -04:00
== Painless Examples
2016-03-18 17:07:43 -04:00
To illustrate how Painless works, let's load some hockey stats into an Elasticsearch index:
2016-04-29 10:42:03 -04:00
[source,js]
2016-03-18 17:07:43 -04:00
----------------------------------------------------------------
2016-04-29 10:42:03 -04:00
PUT hockey/player/_bulk?refresh
2016-03-24 13:34:23 -04:00
{"index":{"_id":1}}
2017-02-01 21:57:07 -05:00
{"first":"johnny","last":"gaudreau","goals":[9,27,1],"assists":[17,46,0],"gp":[26,82,1],"born":"1993/08/13"}
2016-03-24 13:34:23 -04:00
{"index":{"_id":2}}
2017-02-01 21:57:07 -05:00
{"first":"sean","last":"monohan","goals":[7,54,26],"assists":[11,26,13],"gp":[26,82,82],"born":"1994/10/12"}
2016-03-24 13:34:23 -04:00
{"index":{"_id":3}}
2017-02-01 21:57:07 -05:00
{"first":"jiri","last":"hudler","goals":[5,34,36],"assists":[11,62,42],"gp":[24,80,79],"born":"1984/01/04"}
2016-03-24 13:34:23 -04:00
{"index":{"_id":4}}
2017-02-01 21:57:07 -05:00
{"first":"micheal","last":"frolik","goals":[4,6,15],"assists":[8,23,15],"gp":[26,82,82],"born":"1988/02/17"}
2016-03-24 13:34:23 -04:00
{"index":{"_id":5}}
2017-02-01 21:57:07 -05:00
{"first":"sam","last":"bennett","goals":[5,0,0],"assists":[8,1,0],"gp":[26,1,0],"born":"1996/06/20"}
2016-03-24 13:34:23 -04:00
{"index":{"_id":6}}
2017-02-01 21:57:07 -05:00
{"first":"dennis","last":"wideman","goals":[0,26,15],"assists":[11,30,24],"gp":[26,81,82],"born":"1983/03/20"}
2016-03-24 13:34:23 -04:00
{"index":{"_id":7}}
2017-02-01 21:57:07 -05:00
{"first":"david","last":"jones","goals":[7,19,5],"assists":[3,17,4],"gp":[26,45,34],"born":"1984/08/10"}
2016-03-24 13:34:23 -04:00
{"index":{"_id":8}}
2017-02-01 21:57:07 -05:00
{"first":"tj","last":"brodie","goals":[2,14,7],"assists":[8,42,30],"gp":[26,82,82],"born":"1990/06/07"}
2016-03-24 13:34:23 -04:00
{"index":{"_id":39}}
2017-02-01 21:57:07 -05:00
{"first":"mark","last":"giordano","goals":[6,30,15],"assists":[3,30,24],"gp":[26,60,63],"born":"1983/10/03"}
2016-03-24 13:34:23 -04:00
{"index":{"_id":10}}
2017-02-01 21:57:07 -05:00
{"first":"mikael","last":"backlund","goals":[3,15,13],"assists":[6,24,18],"gp":[26,82,82],"born":"1989/03/17"}
2016-03-24 13:34:23 -04:00
{"index":{"_id":11}}
2017-02-01 21:57:07 -05:00
{"first":"joe","last":"colborne","goals":[3,18,13],"assists":[6,20,24],"gp":[26,67,82],"born":"1990/01/30"}
2016-03-18 17:07:43 -04:00
----------------------------------------------------------------
2016-05-09 09:42:23 -04:00
// CONSOLE
2016-04-29 10:42:03 -04:00
// TESTSETUP
2016-03-18 17:07:43 -04:00
[float]
2016-03-24 13:34:23 -04:00
=== Accessing Doc Values from Painless
2016-03-18 17:07:43 -04:00
2016-06-24 12:06:41 -04:00
Document values can be accessed from a `Map` named `doc`.
2016-03-18 17:07:43 -04:00
2016-03-24 13:34:23 -04:00
For example, the following script calculates a player's total goals. This example uses a strongly typed `int` and a `for` loop.
2016-03-18 17:07:43 -04:00
2016-04-29 10:42:03 -04:00
[source,js]
2016-03-18 17:07:43 -04:00
----------------------------------------------------------------
2016-04-29 10:42:03 -04:00
GET hockey/_search
2016-03-24 13:34:23 -04:00
{
"query": {
"function_score": {
"script_score": {
"script": {
"lang": "painless",
2016-05-11 21:32:10 -04:00
"inline": "int total = 0; for (int i = 0; i < doc['goals'].length; ++i) { total += doc['goals'][i]; } return total;"
2016-03-18 17:07:43 -04:00
}
2016-03-24 13:34:23 -04:00
}
2016-03-18 17:07:43 -04:00
}
2016-03-24 13:34:23 -04:00
}
}
2016-03-18 17:07:43 -04:00
----------------------------------------------------------------
2016-05-09 09:42:23 -04:00
// CONSOLE
2016-03-18 17:07:43 -04:00
Alternatively, you could do the same thing using a script field instead of a function score:
2016-04-29 10:42:03 -04:00
[source,js]
2016-03-18 17:07:43 -04:00
----------------------------------------------------------------
2016-04-29 10:42:03 -04:00
GET hockey/_search
2016-03-24 13:34:23 -04:00
{
"query": {
"match_all": {}
},
"script_fields": {
"total_goals": {
"script": {
"lang": "painless",
2016-05-11 21:32:10 -04:00
"inline": "int total = 0; for (int i = 0; i < doc['goals'].length; ++i) { total += doc['goals'][i]; } return total;"
2016-03-24 13:34:23 -04:00
}
2016-03-18 17:07:43 -04:00
}
2016-03-24 13:34:23 -04:00
}
}
2016-03-18 17:07:43 -04:00
----------------------------------------------------------------
2016-05-09 09:42:23 -04:00
// CONSOLE
2016-03-18 17:07:43 -04:00
2016-05-05 18:31:48 -04:00
The following example uses a Painless script to sort the players by their combined first and last names. The names are accessed using
2016-05-11 21:32:10 -04:00
`doc['first'].value` and `doc['last'].value`.
2016-03-18 17:07:43 -04:00
2016-04-29 10:42:03 -04:00
[source,js]
2016-03-18 17:07:43 -04:00
----------------------------------------------------------------
2016-04-29 10:42:03 -04:00
GET hockey/_search
2016-03-24 13:34:23 -04:00
{
"query": {
"match_all": {}
},
"sort": {
"_script": {
2016-04-29 10:42:03 -04:00
"type": "string",
2016-03-24 13:34:23 -04:00
"order": "asc",
"script": {
"lang": "painless",
2016-06-20 11:49:17 -04:00
"inline": "doc['first.keyword'].value + ' ' + doc['last.keyword'].value"
2016-03-24 13:34:23 -04:00
}
2016-03-18 17:07:43 -04:00
}
2016-03-24 13:34:23 -04:00
}
}
2016-03-18 17:07:43 -04:00
----------------------------------------------------------------
2016-05-09 09:42:23 -04:00
// CONSOLE
2016-03-18 17:07:43 -04:00
[float]
2016-03-24 13:34:23 -04:00
=== Updating Fields with Painless
2016-03-18 17:07:43 -04:00
2016-05-11 21:32:10 -04:00
You can also easily update fields. You access the original source for a field as `ctx._source.<field-name>`.
2016-03-18 17:07:43 -04:00
First, let's look at the source data for a player by submitting the following request:
2016-04-29 10:42:03 -04:00
[source,js]
2016-03-18 17:07:43 -04:00
----------------------------------------------------------------
2016-04-29 10:42:03 -04:00
GET hockey/_search
2016-03-24 13:34:23 -04:00
{
2016-06-21 05:27:27 -04:00
"stored_fields": [
2016-03-24 13:34:23 -04:00
"_id",
"_source"
],
"query": {
"term": {
"_id": 1
2016-03-18 17:07:43 -04:00
}
2016-03-24 13:34:23 -04:00
}
}
2016-03-18 17:07:43 -04:00
----------------------------------------------------------------
2016-05-09 09:42:23 -04:00
// CONSOLE
2016-03-18 17:07:43 -04:00
2016-05-11 21:32:10 -04:00
To change player 1's last name to `hockey`, simply set `ctx._source.last` to the new value:
2016-03-18 17:07:43 -04:00
2016-04-29 10:42:03 -04:00
[source,js]
2016-03-18 17:07:43 -04:00
----------------------------------------------------------------
2016-04-29 10:42:03 -04:00
POST hockey/player/1/_update
2016-03-24 13:34:23 -04:00
{
"script": {
"lang": "painless",
2016-05-11 21:32:10 -04:00
"inline": "ctx._source.last = params.last",
2016-03-24 13:34:23 -04:00
"params": {
"last": "hockey"
}
}
}
2016-03-18 17:07:43 -04:00
----------------------------------------------------------------
2016-05-09 09:42:23 -04:00
// CONSOLE
2016-03-18 17:07:43 -04:00
2016-03-24 13:34:23 -04:00
You can also add fields to a document. For example, this script adds a new field that contains
2016-03-18 17:07:43 -04:00
the player's nickname, _hockey_.
2016-04-29 10:42:03 -04:00
[source,js]
2016-03-18 17:07:43 -04:00
----------------------------------------------------------------
2016-04-29 10:42:03 -04:00
POST hockey/player/1/_update
2016-03-24 13:34:23 -04:00
{
"script": {
"lang": "painless",
2016-05-17 11:03:48 -04:00
"inline": "ctx._source.last = params.last; ctx._source.nick = params.nick",
2016-03-24 13:34:23 -04:00
"params": {
"last": "gaudreau",
"nick": "hockey"
}
}
}
2016-03-18 17:07:43 -04:00
----------------------------------------------------------------
2016-05-09 09:42:23 -04:00
// CONSOLE
2016-03-18 17:07:43 -04:00
2017-02-01 21:57:07 -05:00
[float]
[[modules-scripting-painless-dates]]
=== Regular expressions
Dates are a little different to work with than regular values. Here is an
example returning the year of every player's birth:
[source,js]
----------------------------------------------------------------
GET hockey/_search
{
"script_fields": {
"birth_year": {
"script": {
"inline": "doc.born.date.year"
}
}
}
}
----------------------------------------------------------------
// CONSOLE
The key here is that instead of indexing directly into `doc.born` like you would
a normal field you have to call `doc.born.date` to get a
<<painless-api-reference-org-joda-time-ReadableDateTime, `ReadableDateTime`>>.
From there you can call methods like
<<painless-api-reference-org-joda-time-ReadableDateTime-getYear-0, `getYear`>>,
and <<painless-api-reference-org-joda-time-ReadableDateTime-getDayOfWeek-0, `getDayOfWeek`>>.
In the example above `year` is a shortcut to `getYear()`.
If the date field is a list then `date` will always return the first date. To
access all the dates use `dates` instead of `date`.
2016-06-13 21:42:37 -04:00
[float]
2016-06-16 11:07:09 -04:00
[[modules-scripting-painless-regex]]
2016-06-13 21:42:37 -04:00
=== Regular expressions
2016-09-12 12:06:29 -04:00
NOTE: Regexes are disabled by default because they circumvent Painless's
protection against long running and memory hungry scripts. To make matters
worse even innocuous looking regexes can have staggering performance and stack
depth behavior. They remain an amazing powerful tool but are too scary to enable
by default. To enable them yourself set `script.painless.regex.enabled: true` in
`elasticsearch.yml`. We'd like very much to have a safe alternative
implementation that can be enabled by default so check this space for later
developments!
2016-06-13 21:42:37 -04:00
Painless's native support for regular expressions has syntax constructs:
* `/pattern/`: Pattern literals create patterns. This is the only way to create
2016-09-09 03:30:04 -04:00
a pattern in painless. The pattern inside the ++/++'s are just
2016-06-16 11:07:09 -04:00
http://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html[Java regular expressions].
See <<modules-scripting-painless-regex-flags>> for more.
2016-06-13 21:42:37 -04:00
* `=~`: The find operator return a `boolean`, `true` if a subsequence of the
text matches, `false` otherwise.
* `==~`: The match operator returns a `boolean`, `true` if the text matches,
`false` if it doesn't.
Using the find operator (`=~`) you can update all hockey players with "b" in
their last name:
[source,js]
----------------------------------------------------------------
POST hockey/player/_update_by_query
{
"script": {
"lang": "painless",
"inline": "if (ctx._source.last =~ /b/) {ctx._source.last += \"matched\"} else {ctx.op = 'noop'}"
}
}
----------------------------------------------------------------
// CONSOLE
Using the match operator (`==~`) you can update all the hockey players who's
names start with a consonant and end with a vowel:
[source,js]
----------------------------------------------------------------
POST hockey/player/_update_by_query
{
"script": {
"lang": "painless",
"inline": "if (ctx._source.last ==~ /[^aeiou].*[aeiou]/) {ctx._source.last += \"matched\"} else {ctx.op = 'noop'}"
}
}
----------------------------------------------------------------
// CONSOLE
2016-06-24 13:26:46 -04:00
You can use the `Pattern.matcher` directly to get a `Matcher` instance and
remove all of the vowels in all of their last names:
2016-06-13 21:42:37 -04:00
[source,js]
----------------------------------------------------------------
POST hockey/player/_update_by_query
{
"script": {
"lang": "painless",
"inline": "ctx._source.last = /[aeiou]/.matcher(ctx._source.last).replaceAll('')"
}
}
----------------------------------------------------------------
// CONSOLE
2016-06-24 13:26:46 -04:00
`Matcher.replaceAll` is just a call to Java's `Matcher`'s
http://docs.oracle.com/javase/8/docs/api/java/util/regex/Matcher.html#replaceAll-java.lang.String-[replaceAll]
method so it supports `$1` and `\1` for replacements:
[source,js]
----------------------------------------------------------------
POST hockey/player/_update_by_query
{
"script": {
"lang": "painless",
"inline": "ctx._source.last = /n([aeiou])/.matcher(ctx._source.last).replaceAll('$1')"
}
}
----------------------------------------------------------------
// CONSOLE
If you need more control over replacements you can call `replaceAll` on a
`CharSequence` with a `Function<Matcher, String>` that builds the replacement.
This does not support `$1` or `\1` to access replacements because you already
have a reference to the matcher and can get them with `m.group(1)`.
IMPORTANT: Calling `Matcher.find` inside of the function that builds the
replacement is rude and will likely break the replacement process.
This will make all of the vowels in the hockey player's last names upper case:
[source,js]
----------------------------------------------------------------
POST hockey/player/_update_by_query
{
"script": {
"lang": "painless",
"inline": "ctx._source.last = ctx._source.last.replaceAll(/[aeiou]/, m -> m.group().toUpperCase(Locale.ROOT))"
}
}
----------------------------------------------------------------
// CONSOLE
Or you can use the `CharSequence.replaceFirst` to make the first vowel in their
last names upper case:
[source,js]
----------------------------------------------------------------
POST hockey/player/_update_by_query
{
"script": {
"lang": "painless",
"inline": "ctx._source.last = ctx._source.last.replaceFirst(/[aeiou]/, m -> m.group().toUpperCase(Locale.ROOT))"
}
}
----------------------------------------------------------------
// CONSOLE
2016-06-13 21:42:37 -04:00
Note: all of the `_update_by_query` examples above could really do with a
`query` to limit the data that they pull back. While you *could* use a
<<query-dsl-script-query>> it wouldn't be as efficient as using any other query
because script queries aren't able to use the inverted index to limit the
documents that they have to check.