cdbquery: Query Pentaho via the cdb web service interface

In piersharding/RPentaho: RPentaho Pentaho CDA Webservice client interface for R

Description

Query Pentaho via the cdb web service interface. CDB is the Community Data Browser - http://www.webdetails.pt/ctools/cdb.html. This enables users to build and bookmark data queries for later use. The cdb web service provides a JSON based result payload that converts easily to R structures. In this case all resultsets are given back to the user as a data.frame.

Usage

cdbquery(pentaho, group, query, userid=FALSE, withFactors=FALSE,toNumeric=TRUE, toDate=TRUE, ...)

Arguments

pentaho	Pentaho connection object
group	CDB group name
query	CDB query name
userid	Overide the default userid if the group belongs to someoneother than the user credentials - default FALSE
withFactors	Convert character vectors to Factors - default FALSE
toNumeric	Convert numeric vector types to Numeric - default TRUE
toDate	Attempt to convert Date labelled vectors to POSIXct date types - default TRUE
...	Any other named parameters are passed as paramters to the web service call

Details

cdbquery calls the cdb web service to execute a predefined CDB query. These queries are attached to groups that are name spaced by userid eg: group name 'group1', is 'joe.group1' internally, although this is transparent to the user. The query results are parsed and converted into a data.frame object eg:

df <- cdbquery(pentaho, group='group1', query='qry1')

Value

Returns a data.frame.

Note

Not much to note here.

Author(s)

Piers Harding

See Also

RPentaho, cdaquery, cdbquery, cdbgroups

Examples

## Not run: 

pentaho <- RPentaho("conn.yml")
df <- cdbquery(pentaho, group='group1', query='qry1')


## End(Not run)

piersharding/RPentaho documentation built on May 25, 2019, 6:09 a.m.