RForcecom (version 1.1)

rforcecom.bulkQuery: Run Bulk Query

Description

This function is a convenience wrapper for submitting and retrieving bulk query API jobs

Usage

rforcecom.bulkQuery(session,  soqlQuery, object, interval_seconds=5, max_attempts=100,  verbose=FALSE)

Arguments

session

a named character vector defining parameters of the api connection as returned by rforcecom.login

soqlQuery

a character string defining a SOQL query. (ex: "SELECT Id, Name FROM Account")

object

a character string defining the target salesforce object that the operation will be performed on. This must match the target object in the query

interval_seconds

an integer defining the seconds between attempts to check for job completion

max_attempts

an integer defining then max number attempts to check for job completion before stopping

verbose

a boolean on whether to print the API attempt numbers

Value

A data.frame of the recordset returned by query

References

https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/

Examples

## Not run: 
# # select all Ids from Account object
# ids <- rforcecom.bulkQuery(session, soqlQuery='Select Id from Account', object='Account')
# ## End(Not run)