R/Search_uri.R

In elastic: General Purpose Interface to 'Elasticsearch'

#' Full text search of Elasticsearch with URI search
#'
#' @export
#' @template search_par
#' @template search_uri_egs
#' @seealso [fielddata()]
#' @param search_path (character) The path to use for searching. Default
#' to `_search`, but in some cases you may already have that in the base
#' url set using [connect()], in which case you can set this
#' to `NULL`
#' @seealso [Search()] [Search_template()] [count()] [fielddata()]

Search_uri <- function(conn, index=NULL, type=NULL, q=NULL, df=NULL, analyzer=NULL,
  default_operator=NULL, explain=NULL, source=NULL, fields=NULL, sort=NULL,
  track_scores=NULL, timeout=NULL, terminate_after=NULL, from=NULL, size=NULL,
  search_type=NULL, lowercase_expanded_terms=NULL, analyze_wildcard=NULL,
  version=NULL, lenient=NULL, raw=FALSE, asdf=FALSE, track_total_hits = TRUE,
  search_path="_search", stream_opts=list(), ignore_unavailable = FALSE, ...) {

  is_conn(conn)
  search_GET(conn, search_path, cl(index), type,
    args = ec(list(df = df, analyzer = analyzer,
      default_operator = default_operator, explain = as_log(explain),
      `_source` = cl(source), fields = cl(fields), sort = cl(sort),
      track_scores = track_scores, timeout = cn(timeout),
      terminate_after = cn(terminate_after), from = cn(from), size = cn(size),
      search_type = search_type,
      lowercase_expanded_terms = lowercase_expanded_terms,
      analyze_wildcard = analyze_wildcard, version = as_log(version), q = q,
      ignore_unavailable = as_log(ignore_unavailable),
      lenient = as_log(lenient), track_total_hits = ck(track_total_hits))), raw, asdf, stream_opts, ...)
}

search_GET <- function(conn, path, index=NULL, type=NULL, args, raw, asdf, 
                       stream_opts, ...) {
  url <- conn$make_url()
  url <- construct_url(url, path, index, type)
  url <- prune_trailing_slash(url)
  if (!conn$ignore_version) {
    # track_total_hits introduced in ES >= 7.0
    if (conn$es_ver() < 700) args$track_total_hits <- NULL
    # in ES >= v5, lenient param droppped
    if (conn$es_ver() >= 500) args$lenient <- NULL
    # in ES >= v5, fields param changed to stored_fields
    if (conn$es_ver() >= 500) {
      if ("fields" %in% names(args)) {
        stop(
          '"fields" parameter is deprecated in ES >= v5. See help in ?Search_uri', 
          call. = FALSE)
      }
    }
  }
  cli <- crul::HttpClient$new(url = url,
    headers = c(conn$headers, json_type()), 
    opts = c(conn$opts, ...),
    auth = crul::auth(conn$user, conn$pwd)
  )
  tt <- cli$get(query = args)
  geterror(conn, tt)
  if (conn$warn) catch_warnings(tt)
  res <- tt$parse("UTF-8")
  
  if (raw) {
    res 
  } else {
    if (length(stream_opts) != 0) {
      dat <- jsonlite::fromJSON(res, flatten = TRUE)
      stream_opts$x <- dat$hits$hits
      if (length(stream_opts$x) != 0) {
        stream_opts$con <- file(stream_opts$file, open = "ab")
        stream_opts$file <- NULL
        do.call(jsonlite::stream_out, stream_opts)
        close(stream_opts$con)
      } else {
        warning("no scroll results remain", call. = FALSE)
      }
      return(list(`_scroll_id` = dat$`_scroll_id`))
    } else {
      jsonlite::fromJSON(res, asdf, flatten = TRUE)
    }
  }
}