mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 15:47:23 -04:00
179 lines
3.7 KiB
Text
179 lines
3.7 KiB
Text
[[query-dsl-script-query]]
|
|
=== Script query
|
|
++++
|
|
<titleabbrev>Script</titleabbrev>
|
|
++++
|
|
|
|
NOTE: <<runtime,Runtime fields>> provide a very similar feature that is
|
|
more flexible. You write a script to create field values and they
|
|
are available everywhere, such as <<search-fields, `fields`>>,
|
|
<<query-dsl, all queries>>, and <<search-aggregations, aggregations>>.
|
|
|
|
|
|
Filters documents based on a provided <<modules-scripting-using,script>>. The
|
|
`script` query is typically used in a <<query-filter-context,filter context>>.
|
|
|
|
WARNING: Using scripts can result in slower search speeds. See
|
|
<<scripts-and-search-speed>>.
|
|
|
|
|
|
[[script-query-ex-request]]
|
|
==== Example request
|
|
|
|
[source,console]
|
|
----
|
|
GET /_search
|
|
{
|
|
"query": {
|
|
"bool": {
|
|
"filter": {
|
|
"script": {
|
|
"script": """
|
|
double amount = doc['amount'].value;
|
|
if (doc['type'].value == 'expense') {
|
|
amount *= -1;
|
|
}
|
|
return amount < 10;
|
|
"""
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
----
|
|
// TEST[setup:ledger]
|
|
// TEST[s/_search/_search?filter_path=hits.hits&sort=amount/]
|
|
|
|
////
|
|
[source,console-result]
|
|
----
|
|
{
|
|
"hits": {
|
|
"hits": [
|
|
{
|
|
"_id": $body.hits.hits.0._id,
|
|
"_index": $body.hits.hits.0._index,
|
|
"_score": null,
|
|
"_source": $body.hits.hits.0._source,
|
|
"sort": [10.0]
|
|
},
|
|
{
|
|
"_id": $body.hits.hits.1._id,
|
|
"_index": $body.hits.hits.1._index,
|
|
"_score": null,
|
|
"_source": $body.hits.hits.1._source,
|
|
"sort": [50.0]
|
|
},
|
|
{
|
|
"_id": $body.hits.hits.2._id,
|
|
"_index": $body.hits.hits.2._index,
|
|
"_score": null,
|
|
"_source": $body.hits.hits.2._source,
|
|
"sort": [50.0]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
----
|
|
////
|
|
|
|
You can achieve the same results in a search
|
|
query by using runtime fields. Use the
|
|
<<search-fields,`fields`>> parameter on the
|
|
`_search` API to fetch values as part of the
|
|
same query:
|
|
|
|
[source,console]
|
|
----
|
|
GET /_search
|
|
{
|
|
"runtime_mappings": {
|
|
"amount.signed": {
|
|
"type": "double",
|
|
"script": """
|
|
double amount = doc['amount'].value;
|
|
if (doc['type'].value == 'expense') {
|
|
amount *= -1;
|
|
}
|
|
emit(amount);
|
|
"""
|
|
}
|
|
},
|
|
"query": {
|
|
"bool": {
|
|
"filter": {
|
|
"range": {
|
|
"amount.signed": { "lt": 10 }
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"fields": [{"field": "amount.signed"}]
|
|
}
|
|
----
|
|
// TEST[setup:ledger]
|
|
// TEST[s/_search/_search?filter_path=hits.hits.fields&sort=amount.signed:desc/]
|
|
|
|
////
|
|
[source,console-result]
|
|
----
|
|
{
|
|
"hits": {
|
|
"hits": [
|
|
{
|
|
"fields": {"amount.signed": [-10.0]}
|
|
},
|
|
{
|
|
"fields": {"amount.signed": [-50.0]}
|
|
},
|
|
{
|
|
"fields": {"amount.signed": [-50.0]}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
----
|
|
////
|
|
|
|
[[script-top-level-params]]
|
|
==== Top-level parameters for `script`
|
|
|
|
`script`::
|
|
(Required, <<modules-scripting-using, script object>>) Contains a script to run
|
|
as a query. This script must return a boolean value, `true` or `false`.
|
|
|
|
[[script-query-notes]]
|
|
==== Notes
|
|
|
|
[[script-query-custom-params]]
|
|
===== Custom Parameters
|
|
|
|
Like <<query-filter-context,filters>>, scripts are cached for faster execution.
|
|
If you frequently change the arguments of a script, we recommend you store them
|
|
in the script's `params` parameter. For example:
|
|
|
|
[source,console]
|
|
----
|
|
GET /_search
|
|
{
|
|
"query": {
|
|
"bool": {
|
|
"filter": {
|
|
"script": {
|
|
"script": {
|
|
"source": "doc['num1'].value > params.param1",
|
|
"lang": "painless",
|
|
"params": {
|
|
"param1": 5
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
----
|
|
|
|
===== Allow expensive queries
|
|
Script queries will not be executed if <<query-dsl-allow-expensive-queries, `search.allow_expensive_queries`>>
|
|
is set to false.
|