cdbIni: Ini function

In R4CouchDB: A R Convenience Layer for CouchDB 2.0

Description

Function returns a list with some default settings and often used functions such as cdb$baseUrl.

Usage

cdbIni(serverName="localhost",
port="5984",
prot = "http",
DBName="",
uname = "",
pwd = "",
newDBName = "",
removeDBName = "",
id  = "",
fileName = "",
design = "",
view = "",
list = "",
show = "",
queryParam = "",
encSub = "?",
count = 10,
dataList = list(),
attachmentsWithPath=TRUE,
digits = 7)

Arguments

serverName	server name
port	port
prot	name of the protocol default is http
DBName	name of database
uname	name of the user
pwd	password
newDBName	name of the database for cdbMakeDB()
removeDBName	name of the database to remove with cdbRemoveDB()
id	the document id to get, put, post or delete
fileName	for use in cdbAddAttachment
design	the name of the design used when asking a view or list
view	the name of a view to query
list	the name of a list to query
show	the name of a show to query
queryParam	additional query params
encSub	a character which is used as a replacement for chars who can not be converted by iconv
count	how many uuids should be returned by cdbGetUuidS()
dataList	a list containing data to post or update
attachmentsWithPath	effects the result of the function cdbAddAttachment in the way the variable is named
digits	digits kept at toJSON conversion

Details

The list: cdb <- list(serverName = "localhost", ... ) is returned if the packages library(RCurl) and library(RJSONIO) are successfully loaded.

Value

cdb	The R4CouchDB (method) chain(ing) list

Author(s)

wactbprot, parisni

Examples

## Not run: 
ccc <- cdbIni(digits=13,
              DBName="r4couch_db",
              attachmentsWithPath=FALSE,
              dataList=list(normalDistRand =  rnorm(20)))

## End(Not run)

R4CouchDB documentation built on May 2, 2019, 6:05 a.m.