sofa (version 0.4.2)

doc_get: Get a document from a database.

Description

Get a document from a database.

Usage

doc_get(
  cushion,
  dbname,
  docid,
  rev = NULL,
  attachments = FALSE,
  deleted = FALSE,
  revs = FALSE,
  revs_info = FALSE,
  conflicts = FALSE,
  deleted_conflicts = FALSE,
  local_seq = FALSE,
  as = "list",
  ...
)

Value

JSON as a character string or a list (determined by the as parameter)

Arguments

cushion

A Cushion object. Required.

dbname

Database name

docid

Document ID

rev

Revision id of the document to get. If NULL, gets current revision

attachments

(logical) Whether to include _attachments field.

deleted

(logical) Whether to include _deleted field.

revs

(logical) Whether to include _revisions field.

revs_info

(logical) Whether to include _revs_info field.

conflicts

(logical) Whether to include _conflicts field.

deleted_conflicts

(logical) Whether to include _deleted_conflicts field.

local_seq

(logical) Whether to include _local_seq field.

as

(character) One of list (default) or json

...

Curl args passed on to HttpClient

Examples

if (FALSE) {
user <- Sys.getenv("COUCHDB_TEST_USER")
pwd <- Sys.getenv("COUCHDB_TEST_PWD")
(x <- Cushion$new(user = user, pwd = pwd))

if ("sofadb" %in% db_list(x)) {
  invisible(db_delete(x, dbname = "sofadb"))
}
db_create(x, dbname = "sofadb")

# create a document
doc1 <- '{"name": "drink", "type": "drink", "score": 5}'
doc_create(x, dbname = "sofadb", doc1, docid = "asoda")

doc_get(x, dbname = "sofadb", docid = "asoda")
revs <- db_revisions(x, dbname = "sofadb", docid = "asoda")
doc_get(x, dbname = "sofadb", docid = "asoda", rev = revs[1])
doc_get(x, dbname = "sofadb", docid = "asoda", as = "json")
doc_get(x, dbname = "sofadb", docid = "asoda", revs = TRUE)
doc_get(x, dbname = "sofadb", docid = "asoda", revs = TRUE, local_seq = TRUE)
}