R/get_source.R

In tomesch/elasticsearch: Simple Elasticsearch client for R

#' getSource
#'
#' Get the source of a document by its index, type and id.
#'
#' \code{getSource} retrieves source from index
#' @param index String The name of the index
#' @param type String The type of the document; use _all to fetch the first document matching the ID across all types
#' @param id String The document ID
#' @param parent String The ID of the parent document
#' @param source String, String[], Logical True or false to return the _source field or not, or a list of fields to return
#' @param source_include String, String[], Logical A list of fields to extract and return from the _source field
#' @param source_exclude String, String[], Logical A list of fields to exclude from the returned _source field
#' @param realtime Logical Specify whether to perform the operation in realtime or search mode
#' @param routing String Specific routing value
#' @param preference String Specify the node or shard the operation should be performed on (default: random)
#' @param refresh Logical Refresh the shard containing the document before performing the operation
#' @param version Number Explicit version number for concurrency control
#' @param versionType String Specific version type
#'
#'
#' @export getSource
getSource <- function (client, ...) {
  UseMethod("getSource", client)
}

#' @rdname getSource
#' @export
getSource.elasticsearch <- function (client, index, type = "_all", id, parent = NULL, source = TRUE,
                                     realtime = TRUE, routing = NULL, preference = "random",
                                     refresh = FALSE, version = NULL, version_type = NULL, raw = FALSE,
                                     validate_params = TRUE, source_include = NULL,
                                     source_exclude = NULL) {
  args = as.list(match.call())
  args[[1]] = NULL
  args[['get_source']] = TRUE
  do.call(get, args)
}