docs_delete: Delete a document

Description Usage Arguments References Examples

View source: R/docs_delete.R

Description

Delete a document

Usage

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

Arguments

index

(character) The name of the index. Required

type

(character) The type of the document. Required

id

(numeric/character) The document ID. Can be numeric or character. Required

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 httr::DELETE()

...

Further args to query DSL

References

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

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
## Not run: 
if (!index_exists("plos")) {
 plosdat <- system.file("examples", "plos_data.json", package = "elastic")
 docs_bulk(plosdat)
}

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

## End(Not run)

ropensci/elastic documentation built on April 14, 2018, 10:22 a.m.