OpenSearch/docs/reference/query-dsl/script-query.asciidoc
Itamar Syn-Hershko 156b3cae15 [Docs] Fix filter context in script-query.asciidoc (#35677)
The docs say script queries are typically used in a filter context but
the example uses a boolean must clause.
2018-11-19 16:30:33 +01:00

58 lines
1.4 KiB
Plaintext

[[query-dsl-script-query]]
=== Script Query
A query allowing to define
<<modules-scripting,scripts>> as queries. They are typically used in a filter
context, for example:
[source,js]
----------------------------------------------
GET /_search
{
"query": {
"bool" : {
"filter" : {
"script" : {
"script" : {
"source": "doc['num1'].value > 1",
"lang": "painless"
}
}
}
}
}
}
----------------------------------------------
// CONSOLE
[float]
==== Custom Parameters
Scripts are compiled and cached for faster execution. If the same script
can be used, just with different parameters provider, it is preferable
to use the ability to pass parameters to the script itself, for example:
[source,js]
----------------------------------------------
GET /_search
{
"query": {
"bool" : {
"filter" : {
"script" : {
"script" : {
"source" : "doc['num1'].value > params.param1",
"lang" : "painless",
"params" : {
"param1" : 5
}
}
}
}
}
}
}
----------------------------------------------
// CONSOLE