New

The executive guide to generative AI

Read more
About usPartnersSupport|Login

WARNING: Version 2.3 of Elasticsearch has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Template Query Span queries »
Elastic Docs ›Elasticsearch Guide [2.3] ›Query DSL ›Specialized queries

Script Query

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Script Query

edit

A query allowing to define scripts as queries. They are typically used in a filter context, for example:

"bool" : {
    "must" : {
        ...
    },
    "filter" : {
        "script" : {
            "script" : "doc['num1'].value > 1"
        }
    }
}

Custom Parameters

edit

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:

"bool" : {
    "must" : {
        ...
    },
    "filter" : {
        "script" : {
            "script" : {
                "inline" : "doc['num1'].value > param1"
                "params" : {
                    "param1" : 5
                }
            }
        }
    }
}
« Template Query Span queries »

On this page

Was this helpful?
Feedback