From 201acf59c7c7808711e2eb4cebfa0fe7c5c72f48 Mon Sep 17 00:00:00 2001 From: Clinton Gormley Date: Wed, 28 Jan 2015 14:18:05 +0100 Subject: [PATCH] Docs: Improved the template query docs Added the `file` and `id` parameters. Closes #9458 --- .../query-dsl/queries/template-query.asciidoc | 82 +++---------------- 1 file changed, 13 insertions(+), 69 deletions(-) diff --git a/docs/reference/query-dsl/queries/template-query.asciidoc b/docs/reference/query-dsl/queries/template-query.asciidoc index 166be1c7c976d..6810b0663ea27 100644 --- a/docs/reference/query-dsl/queries/template-query.asciidoc +++ b/docs/reference/query-dsl/queries/template-query.asciidoc @@ -24,6 +24,19 @@ GET /_search The above request is translated into: +[source,js] +------------------------------------------ +GET /_search +{ + "query": { + "match": { + "text": "all about search" + } + } +} + +------------------------------------------ + Alternatively passing the template as an escaped string works as well: [source,js] @@ -96,75 +109,6 @@ GET /_search <1> Name of the the query template in `config/scripts/`, i.e., `storedTemplate.mustache`. -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: - - -[source,js] ------------------------------------------- -GET /_search -{ - "query": { - "template": { - "query": {"match_{{template}}": {}}, - "params" : { - "template" : "all" - } - } - } -} ------------------------------------------- - -which is then turned into: - -[source,js] ------------------------------------------- -{ - "query": { - "match_all": {} - } -} ------------------------------------------- - -You can register a template by storing it in the elasticsearch index `.scripts` or by using the REST API. (See <> for more details) -In order to execute the stored template, reference it by name in the `query` -parameter: - - -[source,js] ------------------------------------------- -GET /_search -{ - "query": { - "template": { - "query": "templateName", <1> - "params" : { - "template" : "all" - } - } - } -} ------------------------------------------- -<1> Name of the the query template stored in the index. - -[source,js] ------------------------------------------- -GET /_search -{ - "query": { - "template": { - "query": "storedTemplate", <1> - "params" : { - "template" : "all" - } - } - } -} - ------------------------------------------- - - There is also a dedicated `template` endpoint, allows you to template an entire search request. Please see <> for more details.