R/doc_delete.r

In sofa: Connector to 'CouchDB'

#' Delete a document in a database.
#'
#' @export
#' @template all
#' @template return
#' @param dbname Database name. (character)
#' @param docid Document ID (character)
#' @examples \dontrun{
#' user <- Sys.getenv("COUCHDB_TEST_USER")
#' pwd <- Sys.getenv("COUCHDB_TEST_PWD")
#' (x <- Cushion$new(user=user, pwd=pwd))
#'
#' # create a database
#' if ("sofadb" %in% db_list(x)) {
#'   invisible(db_delete(x, dbname="sofadb"))
#' }
#' db_create(x, dbname='sofadb')
#'
#' doc3 <- "<top><a/><b/><c><d/><e>bob</e></c></top>"
#' doc_create(x, dbname="sofadb", doc=doc3, docid="newnewxml")
#' doc_delete(x, dbname="sofadb", docid="newnewxml")
#'
#' # wrong docid name
#' doc_create(x, dbname="sofadb", doc=doc3, docid="newxml")
#' # doc_delete(x, dbname="sofadb", docid="wrongname")
#' }
doc_delete <- function(cushion, dbname, docid, as = 'list', ...) {
  revget <- doc_get(cushion, dbname, docid)[["_rev"]]
  check_cushion(cushion)
  url <- file.path(cushion$make_url(), dbname, docid)
  sofa_DELETE(url, as, headers = cushion$get_headers(),
              auth = cushion$get_auth(), query = list(rev = revget), ...)
}