mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 04:58:50 +00:00
a03b6c2fa5
This commit adds back "id" as the key within a script to specify a stored script (which with file scripts now gone is no longer ambiguous). It also adds "source" as a replacement for "code". This is in an attempt to normalize how scripts are specified across both put stored scripts and script usages, including search template requests. This also deprecates the old inline/stored keys.
74 lines
2.2 KiB
Plaintext
74 lines
2.2 KiB
Plaintext
[[search-request-script-fields]]
|
|
=== Script Fields
|
|
|
|
Allows to return a <<modules-scripting,script
|
|
evaluation>> (based on different fields) for each hit, for example:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /_search
|
|
{
|
|
"query" : {
|
|
"match_all": {}
|
|
},
|
|
"script_fields" : {
|
|
"test1" : {
|
|
"script" : {
|
|
"lang": "painless",
|
|
"source": "doc['my_field_name'].value * 2"
|
|
}
|
|
},
|
|
"test2" : {
|
|
"script" : {
|
|
"lang": "painless",
|
|
"source": "doc['my_field_name'].value * factor",
|
|
"params" : {
|
|
"factor" : 2.0
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
|
|
|
|
Script fields can work on fields that are not stored (`my_field_name` in
|
|
the above case), and allow to return custom values to be returned (the
|
|
evaluated value of the script).
|
|
|
|
Script fields can also access the actual `_source` document and
|
|
extract specific elements to be returned from it by using `params['_source']`.
|
|
Here is an example:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /_search
|
|
{
|
|
"query" : {
|
|
"match_all": {}
|
|
},
|
|
"script_fields" : {
|
|
"test1" : {
|
|
"script" : "params['_source']['message']"
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[setup:twitter]
|
|
|
|
Note the `_source` keyword here to navigate the json-like model.
|
|
|
|
It's important to understand the difference between
|
|
`doc['my_field'].value` and `params['_source']['my_field']`. The first,
|
|
using the doc keyword, will cause the terms for that field to be loaded to
|
|
memory (cached), which will result in faster execution, but more memory
|
|
consumption. Also, the `doc[...]` notation only allows for simple valued
|
|
fields (can't return a json object from it) and make sense only on
|
|
non-analyzed or single term based fields. However, using `doc` is
|
|
still the recommended way to access values from the document, if at all
|
|
possible, because `_source` must be loaded and parsed every time it's used.
|
|
Using `_source` is very slow.
|
|
|