R/documents.R

In ropensci/elastic: General Purpose Interface to 'Elasticsearch'

#' Elasticsearch documents functions.
#'
#' @name documents
#' @details There are five functions to work directly with documents.
#'
#' - [docs_get()]
#' - [docs_mget()]
#' - [docs_create()]
#' - [docs_delete()]
#' - [docs_bulk()]
#'
#' @examples \dontrun{
#' # Get a document
#' # docs_get(index='plos', type='article', id=1)
#'
#' # Get multiple documents
#' # docs_mget(index="shakespeare", type="line", id=c(9,10))
#'
#' # Create a document
#' # docs_create(index='plos', type='article', id=35, body=list(id="12345", title="New title"))
#' 
#' # Delete a document
#' # docs_delete(index='plos', type='article', id=35)
#'
#' # Bulk load documents
#' # plosdat <- system.file("examples", "plos_data.json", package = "elastic")
#' # docs_bulk(plosdat)
#' }
NULL