docs_delete: Delete a document

In elastic: General Purpose Interface to 'Elasticsearch'

Description

Delete a document

Usage

docs_delete(
  conn,
  index,
  id,
  type = NULL,
  refresh = NULL,
  routing = NULL,
  timeout = NULL,
  version = NULL,
  version_type = NULL,
  callopts = list(),
  ...
)

Arguments

conn	an Elasticsearch connection object, see connect()
index	(character) The name of the index. Required
id	(numeric/character) The document ID. Can be numeric or character. Required
type	(character) The type of the document. optional
refresh	(logical) Refresh the index after performing the operation
routing	(character) Specific routing value
timeout	(character) Explicit operation timeout, e.g,. 5m (for 5 minutes)
version	(character) Explicit version number for concurrency control
version_type	(character) Specific version type. One of internal or external
callopts	Curl args passed on to crul::HttpClient
...	Further args to query DSL

References

https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html

Examples

## Not run: 
(x <- connect())
x$ping()

if (!index_exists(x, "plos")) {
 plosdat <- system.file("examples", "plos_data.json",
    package = "elastic")
 plosdat <- type_remover(plosdat)
 docs_bulk(x, plosdat)
}

# delete a document
if (!docs_get(x, index='plos', id=36, exists=TRUE)) {
  docs_create(x, index='plos', id=36, 
    body = list(id="12345", title="New title")
  )
}
docs_get(x, index='plos', id=36)
docs_delete(x, index='plos', id=36)
# docs_get(x, index='plos', id=36) # and the document is gone

## End(Not run)

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