db_explain: Explain API

In ropensci/sofa: Connector to 'CouchDB'

Explain API

Description

Explain API

Usage

db_explain(
  cushion,
  dbname,
  query = NULL,
  selector = NULL,
  limit = NULL,
  skip = NULL,
  sort = NULL,
  fields = NULL,
  use_index = NULL,
  as = "list",
  ...
)

Arguments

cushion	A Cushion object. Required.
dbname	Database name
query	(character) instead of using the other parameters, you can compose one R list or json blob here
selector	(json) - JSON object describing criteria used to select documents. More information provided in the section on selector syntax. See the query_tutorial in this package, and the selectors docs http://docs.couchdb.org/en/2.0.0/api/database/find.html#find-selectors
limit	(number) - Maximum number of results returned. Default: 25 Optional
skip	(number) - Skip the first 'n' results, where 'n' is the value specified. Optional
sort	(json) - JSON array following sort syntax. Optional. See http://docs.couchdb.org/en/2.0.0/api/database/find.html#find-sort For some reason, sort doesn't work often, not sure why.
fields	(json) - JSON array specifying which fields of each object should be returned. If it is omitted, the entire object is returned. More information provided in the section on filtering fields. Optional See http://docs.couchdb.org/en/2.0.0/api/database/find.html#find-filter
use_index	(json) - Instruct a query to use a specific index. Specified either as ⁠<design_document>⁠ or ⁠["<design_document>", "<index_name>"]⁠. Optional
as	(character) One of list (default) or json
...	Curl args passed on to HttpClient

Value

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

Examples

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

file <- system.file("examples/omdb.json", package = "sofa")
strs <- readLines(file)

## create a database
if ("omdb" %in% db_list(x)) {
  invisible(db_delete(x, dbname="omdb"))
}
db_create(x, dbname='omdb')

## add some documents
invisible(db_bulk_create(x, "omdb", strs))

## query all in one json blob
db_explain(x, dbname = "omdb", query = '{
  "selector": {
    "_id": {
      "$gt": null
    }
  }
}')

## End(Not run)

ropensci/sofa documentation built on March 10, 2024, 4:26 a.m.