elastic (version 0.7.6)

Search_template: Search or validate templates

Description

Search or validate templates

Usage

Search_template(body = list(), raw = FALSE, ...)
Search_template_register(template, body = list(), raw = FALSE, ...)
Search_template_get(template, ...)
Search_template_delete(template, ...)
Search_template_render(body = list(), raw = FALSE, ...)

Arguments

body

Query, either a list or json.

raw

(logical) If FALSE (default), data is parsed to list. If TRUE, then raw JSON returned

...

Curl args passed on to POST

template

(character) a template name

Template search

With Search_template you can search with a template, using mustache templating. Added in Elasticsearch v1.1

Template render

With Search_template_render you validate a template without conducting the search. Added in Elasticsearch v2.0

Pre-registered templates

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", ...

See Also

Search, Search_uri

Examples

## Not run: 
# if (!index_exists("iris")) {
#   invisible(docs_bulk(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(body = body1)
# 
# body2 <- '{
#  "inline": {
#    "query": {
#       "match": {
#           "Species": "{{query_string}}"
#       }
#    }
#  },
#  "params": {
#    "query_string": "versicolor"
#  }
# }'
# Search_template(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(body = mylist)
# 
# ## Validating templates w/ Search_template_render()
# Search_template_render(body = body1)
# Search_template_render(body = body2)
# 
# ## pre-registered templates
# ### register a template
# body3 <- '{
#   "template": {
#      "query": {
#          "match": {
#              "Species": "{{query_string}}"
#          }
#      }
#    }
# }'
# Search_template_register('foobar', body = body3)
# 
# ### get template
# Search_template_get('foobar')
# 
# ### use the template
# body4 <- '{
#  "id": "foobar",
#   	"params": {
#       "query_string": "setosa"
#   }
# }'
# Search_template(body = body4)
# 
# ### delete the template
# Search_template_delete('foobar')
# ## End(Not run)