salesforcer: rforcecom.bulkQuery – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

rforcecom.bulkQuery

The salesforcer backwards compatible version of rforcecom.bulkQuery

Soft-deprecated lifecycle

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

`session`	`list`; a list containing `"sessionID"`, `"instanceURL"`, and `"apiVersion"` as returned by `rforcecom.login`. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.
`soqlQuery`	`character`; a string defining a SOQL query (e.g. "SELECT Id, Name FROM Account").
`object`	`character`; the name of one Salesforce objects that the function is operating against (e.g. "Account", "Contact", "CustomObject__c")
`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`	`logical`; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to `TRUE` the URL, header, and body will be printed for each request, along with additional diagnostic information where available.

A data.frame of the recordset returned by query

An Implementation of 'Salesforce' APIs Using Tidy Principles

v0.2.2

MIT + file LICENSE

Authors

Steven M. Mortimer [aut, cre], Takekatsu Hiramura [ctb], Jennifer Bryan [ctb, cph], Joanna Zhao [ctb, cph]

Initial release

2020-09-07