View source: R/search_template.R
Search_template | R Documentation |
Search or validate templates
Search_template(conn, body = list(), raw = FALSE, ...)
Search_template_register(conn, template, body = list(), raw = FALSE, ...)
Search_template_get(conn, template, ...)
Search_template_delete(conn, template, ...)
Search_template_render(conn, body = list(), raw = FALSE, ...)
conn |
an Elasticsearch connection object, see |
body |
Query, either a list or json. |
raw |
(logical) If |
... |
Curl args passed on to crul::verb-POST |
template |
(character) a template name |
With Search_template
you can search with a template, using
mustache templating. Added in Elasticsearch v1.1
With Search_template_render
you validate a template without
conducting the search. Added in Elasticsearch v2.0
Register a template with Search_template_register
. You can get
the template with Search_template_get
and delete the template
with Search_template_delete
You can also pre-register search templates by storing them in the
config/scripts
directory, in a file using the .mustache
extension. In order to execute the stored template, reference it
by it's name under the template key, like
"file": "templateName", ...
https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html
Search()
, Search_uri()
## Not run:
# connection setup
(x <- connect())
if (!index_exists(x, "iris")) {
invisible(docs_bulk(x, iris, "iris"))
}
body1 <- '{
"inline" : {
"query": { "match" : { "{{my_field}}" : "{{my_value}}" } },
"size" : "{{my_size}}"
},
"params" : {
"my_field" : "Species",
"my_value" : "setosa",
"my_size" : 3
}
}'
Search_template(x, body = body1)
body2 <- '{
"inline": {
"query": {
"match": {
"Species": "{{query_string}}"
}
}
},
"params": {
"query_string": "versicolor"
}
}'
Search_template(x, body = body2)
# pass in a list
mylist <- list(
inline = list(query = list(match = list(`{{my_field}}` = "{{my_value}}"))),
params = list(my_field = "Species", my_value = "setosa", my_size = 3L)
)
Search_template(x, body = mylist)
## Validating templates w/ Search_template_render()
Search_template_render(x, body = body1)
Search_template_render(x, body = body2)
## pre-registered templates
### register a template
if (x$es_ver() <= 520) {
body3 <- '{
"template": {
"query": {
"match": {
"Species": "{{query_string}}"
}
}
}
}'
Search_template_register(x, 'foobar', body = body3)
} else {
body3 <- '{
"script": {
"lang": "mustache",
"source": {
"query": {
"match": {
"Species": "{{query_string}}"
}
}
}
}
}'
Search_template_register(x, 'foobar', body = body3)
}
### get template
Search_template_get(x, 'foobar')
### use the template
body4 <- '{
"id": "foobar",
"params": {
"query_string": "setosa"
}
}'
Search_template(x, body = body4)
### delete the template
Search_template_delete(x, 'foobar')
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.