db_alldocs: List all docs in a given database.

In ropensci/sofa: Connector to 'CouchDB'

List all docs in a given database.

Description

List all docs in a given database.

Usage

db_alldocs(
  cushion,
  dbname,
  descending = NULL,
  startkey = NULL,
  endkey = NULL,
  limit = NULL,
  include_docs = FALSE,
  as = "list",
  disk = NULL,
  ...
)

Arguments

cushion	A Cushion object. Required.
dbname	Database name. (character)
descending	Return in descending order? (logical)
startkey	Document ID to start at. (character)
endkey	Document ID to end at. (character)
limit	Number document IDs to return. (numeric)
include_docs	(logical) If TRUE, returns docs themselves, in addition to IDs. Default: FALSE
as	(character) One of list (default) or json
disk	write to disk or not. By default, data is in the R session; if you give a file path, we'll write data to disk and you'll get back the file path. by default, we save in the R session
...	Curl args passed on to HttpClient

Value

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

Examples

## Not run: 
user <- Sys.getenv("COUCHDB_TEST_USER")
pwd <- Sys.getenv("COUCHDB_TEST_PWD")
(x <- Cushion$new(user = user, pwd = pwd))

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

db_alldocs(x, dbname = "leothelion")
db_alldocs(x, dbname = "leothelion", as = "json")
db_alldocs(x, dbname = "leothelion", limit = 2)
db_alldocs(x, dbname = "leothelion", limit = 2, include_docs = TRUE)

# curl options
res <- db_alldocs(x, dbname = "leothelion", verbose = TRUE)

# write data to disk - useful when data is very large
## create omdb dataset first
file <- system.file("examples/omdb.json", package = "sofa")
strs <- readLines(file)
if ("omdb" %in% db_list(x)) {
  invisible(db_delete(x, dbname = "omdb"))
}
db_create(x, dbname = "omdb")
invisible(db_bulk_create(x, "omdb", strs))

## get all docs, writing them to disk
res <- db_alldocs(x, dbname = "omdb", disk = (f <- tempfile(fileext = ".json")))
res
readLines(res, n = 10)

## End(Not run)

ropensci/sofa documentation built on Feb. 7, 2025, 1:31 a.m.