jSonarR (version 1.1.1)

sonarCSV: Get a CSV document for a saved query

Description

Execute a find query which has been saved and published in JSON Studio Finder, and get the response in an R data frame that represents Mongo's data in tabular form.

Usage

sonarCSV(connection, queryName, queryCol, type, bind = list(), limit = NULL, idCol = "_id", publishedBy = NULL, colClasses = NA)

Arguments

connection

a SonarConnection object created with new.SonarConnection

queryName

the name of the saved query to execute

queryCol

a collection in the database to use with the query

type

the type of query to execute ('agg' or 'find')

bind

a list of bind variables and their values

limit

the maximum number of results to return

idCol

the name of a field which uniquely identifies each document. This will be used for the row names in the returned data frame. The default is X_id, which is the name of Mongo's _id field (adjusted by make.names).

publishedBy

the name of the user who we expect published the API

colClasses

a list of column names and their respective classes, as used in read.csv. This may be necessary if some columns' types are not being detected automatically.

Details

The parameters for this function are explained in greater detail in the JSON Studio help page Using the Gateway.

See Also

http://jsonstudio.com/wp-content/uploads/2014/04/manual141/_build/html/index.html

Other connection: new.SonarConnection; sonarAgg; sonarFind; sonarJSON

Other csv: sonarAgg; sonarFind

Examples

connection <- new.SonarConnection('https://example.com', 'localhost', 'test')

delays <- sonarCSV(connection, 'delayed_flights', 'WAFlights', type='find')
cor(delays$ACTUAL_ELAPSED_TIME, delays$WEATHER_DELAY)