honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix example in documentation for Painless using _source. (#21322)

This commit is contained in:
Jack Conradson 2017-03-15 17:18:34 -07:00 committed by GitHub
parent b902ab9e89
commit 4c11ebc8b9
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/reference/search/request/script-fields.asciidoc
View File

@ -37,9 +37,9 @@ 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 indexed and
extract specific elements to be returned from it (can be an "object"
type). Here is an example:
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]
--------------------------------------------------
@ -50,22 +50,24 @@ GET /_search
},
"script_fields" : {
"test1" : {
"script" : "_source.obj1.obj2"
"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 `_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
`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.
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.
The `_source` on the other hand causes the source to be loaded, parsed,
and then only the relevant part of the json is returned.