R/defunct.R

Defines functions info mapping_delete index_status nodes_shutdown mlt

Documented in index_status info mapping_delete mlt nodes_shutdown

#' Defunct functions in elastic
#'
#' - [mlt()]: The MLT API has been removed, use More Like This Query 
#'  via [Search()]
#' - [nodes_shutdown()]: The _shutdown API has been removed. Instead, 
#'  setup Elasticsearch to run as a service (see Running as a Service on Linux 
#'  (<https://www.elastic.co/guide/en/elasticsearch/reference/2.0/setup-service.html>) or 
#'  Running as a Service on Windows 
#'  (<https://www.elastic.co/guide/en/elasticsearch/reference/2.0/setup-service-win.html>)) 
#'  or use the -p command line option to write the PID to a file.
#' - [index_status()]: _status route for the index API has been removed. 
#'  Replaced with the Indices Stats and Indices Recovery APIs.
#' - [mapping_delete()]: Elasticsearch dropped this route in their API. Instead 
#'  of deleting a mapping, delete the index and recreate with a new mapping.
#' 
#' @name elastic-defunct
NULL

#' This function is defunct
#' @export
#' @rdname mlt-defunct
#' @keywords internal
mlt <- function(...){
  .Defunct(msg = "The MLT API has been removed. See ?`elastic-defunct`")
}

#' This function is defunct
#' @export
#' @rdname nodes-defunct
#' @keywords internal
nodes_shutdown <- function(...){
  .Defunct(msg = "The _shutdown API has been removed. See ?`elastic-defunct`")
}

#' This function is defunct
#' @export
#' @rdname index_status-defunct
#' @keywords internal
index_status <- function(...) {
  .Defunct(msg = "_status route for the index API has been removed. See ?`elastic-defunct`")
}

#' Mapping delete
#' @export
#' @rdname mapping_delete-defunct
#' @keywords internal
mapping_delete <- function(...){
  .Defunct(msg = "This function is defunct. Instead of deleting a mapping\ndelete the index and recreate with a new mapping")
}

#' This function is defunct
#' @export
#' @rdname info-defunct
#' @keywords internal
info <- function(...){
  .Defunct(msg = "See `?connect` for the `info()` method")
}

Try the elastic package in your browser

Any scripts or data that you put into this service are public.

elastic documentation built on March 17, 2021, 1:07 a.m.