Initialize a query with a specified query string

query_str(
  con,
  index = NULL,
  str,
  path = NULL,
  time_scroll = "5m",
  max = 0,
  type = c("unknown", "fetch", "agg"),
  format = c("list", "json"),
  check_fields = TRUE
)

Arguments

con

an es_connect() object

index

the name of the index to query (if not specified, will fall back on 'primary_index' provided to es_connect())

str

query string

path

an optional directory to write documents to as they are fetched

time_scroll

specify how long a consistent view of the index should be maintained for scrolled search, e.g. "1m" (used when type=="fetch"

max

maximum number of documents to fetch (used when type=="fetch")

type

the type of query defined in the string - one of "unknown", "fetch", or "agg"

format

format of returned output - either "list" or "json"

check_fields

should field names be checked when the query is augmented?