sofa (version 0.2.0)

design_search: Search design documents

Description

Search design documents

Usage

design_search(cushion, dbname, design, view, conflicts = NULL, descending = NULL, endkey = NULL, end_key = NULL, endkey_docid = NULL, end_key_doc_id = NULL, group = NULL, group_level = NULL, include_docs = NULL, attachments = NULL, att_encoding_info = NULL, inclusive_end = NULL, key = NULL, keys = NULL, limit = NULL, reduce = NULL, skip = NULL, sorted = NULL, stale = NULL, startkey = NULL, start_key = NULL, startkey_docid = NULL, start_key_doc_id = NULL, update_seq = NULL, as = "list", ...)

Arguments

cushion

A Cushion object. Required.

dbname

(character) Database name. required.

design

(character) Design document name. this is the design name without _design/, which is prepended internally. required.

view

(character) a view, same as fxn param in design_create_. required.

conflicts

(logical) Includes conflicts information in response. Ignored if include_docs isn't TRUE. Default: FALSE

descending

(logical) Return the documents in descending by key order. Default: FALSE

endkey, end_key

(list) Stop returning records when the specified key is reached. Optional. end_key is an alias for endkey

endkey_docid, end_key_doc_id

(character) Stop returning records when the specified document ID is reached. Requires endkey to be specified for this to have any effect. Optional. end_key_doc_id is an alias for endkey_docid

group

(logical) Group the results using the reduce function to a group or single row. Default: FALSE

group_level

(integer) Specify the group level to be used. Optional

include_docs

(logical) Include the associated document with each row. Default: FALSE.

attachments

(logical) Include the Base64-encoded content of attachments in the documents that are included if include_docs is TRUE. Ignored if include_docs isn't TRUE. Default: FALSE

att_encoding_info

(logical) Include encoding information in attachment stubs if include_docs is TRUE and the particular attachment is compressed. Ignored if include_docs isn't TRUE. Default: FALSE.

inclusive_end

(logical) Specifies whether the specified end key should be included in the result. Default: TRUE

key

(list) Return only documents that match the specified key. Optional

keys

(list) Return only documents where the key matches one of the keys specified in the array. Optional

limit

(integer) Limit the number of the returned documents to the specified number. Optional

reduce

(logical) Use the reduction function. Default: TRUE

skip

(integer) Skip this number of records before starting to return the results. Default: 0

sorted

(logical) Sort returned rows (see Sorting Returned Rows). Setting this to FALSE offers a performance boost. The total_rows and offset fields are not available when this is set to FALSE. Default: TRUE

stale

(character) Allow the results from a stale view to be used. Supported values: ok and update_after. Optional

startkey, start_key

(list) Return records starting with the specified key. Optional. start_key is an alias for startkey

startkey_docid, start_key_doc_id

(character) Return records starting with the specified document ID. Requires startkey to be specified for this to have any effect. Optional. start_key_doc_id is an alias for startkey_docid

update_seq

(logical) Response includes an update_seq value indicating which sequence id of the database the view reflects. Default: FALSE

as

(character) One of list (default) or json

...

Curl args passed on to one of the HTTP verbs (e.g,. GET, POST, PUT, etc.)

Value

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

Details

Note that we only support GET for this method, and not POST. Let us know if you want POST support

References

http://docs.couchdb.org/en/latest/api/ddoc/views.html

Examples

## Not run: 
# (x <- Cushion$new())
# 
# 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 the documents
# invisible(db_bulk_create(x, "omdb", strs))
# 
# # Create a view, the easy way, but less flexible
# design_create(x, dbname='omdb', design='view1', fxnname="foobar1")
# design_create(x, dbname='omdb', design='view2', fxnname="foobar2",
#   value="doc.Country")
# design_create(x, dbname='omdb', design='view5', fxnname="foobar3",
#   value="[doc.Country,doc.imdbRating]")
# 
# # Search using a view
# compact <- function(l) Filter(Negate(is.null), l)
# res <- design_search(x, dbname='omdb', design='view2', view ='foobar2')
# head(
#   do.call(
#     "rbind.data.frame",
#     Filter(
#       function(z) length(z) == 2,
#       lapply(res$rows, function(x) compact(x[names(x) %in% c('id', 'value')]))
#     )
#   )
# )
# 
# res <- design_search(x, dbname='omdb', design='view5', view = 'foobar3')
# head(
#   structure(do.call(
#     "rbind.data.frame",
#     lapply(res$rows, function(x) x$value)
#   ), .Names = c('Country', 'imdbRating'))
# )
# 
# # query parameters
# ## limit
# design_search(x, dbname='omdb', design='view5', view = 'foobar3',
#   limit = 5)
# ## End(Not run)