New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« More Like This Query Script Query »
Elastic Docs ›Elasticsearch Guide [5.3] ›Query DSL ›Specialized queries

Template Query

edit

Template Query

edit

Deprecated in 5.0.0.

Use the Search Template API

A query that accepts a query template and a map of key/value pairs to fill in template parameters. Templating is based on Mustache. For simple token substitution all you provide is a query containing some variable that you want to substitute and the actual values:

GET /_search
{
    "query": {
        "template": {
            "inline": { "match": { "text": "{{query_string}}" }},
            "params" : {
                "query_string" : "all about search"
            }
        }
    }
}
Copy as curlTry in Elastic 

The above request is translated into:

GET /_search
{
    "query": {
        "match": {
            "text": "all about search"
        }
    }
}
Copy as curlTry in Elastic 

Alternatively passing the template as an escaped string works as well:

GET /_search
{
    "query": {
        "template": {
            "inline": "{ \"match\": { \"text\": \"{{query_string}}\" }}", 
            "params" : {
                "query_string" : "all about search"
            }
        }
    }
}
Copy as curlTry in Elastic 

New line characters (\n) should be escaped as \\n or removed, and quotes (") should be escaped as \\".

Stored templates

edit

You can register a template by storing it in the config/scripts directory, in a file using the .mustache extension. In order to execute the stored template, reference it by name in the file parameter:

GET /_search
{
    "query": {
        "template": {
            "file": "my_template", 
            "params" : {
                "query_string" : "all about search"
            }
        }
    }
}
Copy as curlTry in Elastic 

Name of the query template in config/scripts/, i.e., my_template.mustache.

Alternatively, you can register a query template in the cluster state with:

PUT /_search/template/my_template
{
    "template": { "match": { "text": "{{query_string}}" }}
}
Copy as curlTry in Elastic 

and refer to it in the template query with the id parameter:

GET /_search
{
    "query": {
        "template": {
            "stored": "my_template", 
            "params" : {
                "query_string" : "all about search"
            }
        }
    }
}
Copy as curlTry in Elastic 

Name of the query template in config/scripts/, i.e., my_template.mustache.

There is also a dedicated template endpoint, allows you to template an entire search request. Please see Search Template for more details.

« More Like This Query Script Query »

On this page

Was this helpful?
Feedback