Skip to contents

Perform an abitrary SOQL query against an arbitrary dataset, and return the results as a tibble.

Source: R/soda.R
do_soda_query.Rd

Perform an abitrary SOQL query against an arbitrary dataset, and return the results as a tibble.

Usage

do_soda_query(
  query,
  api_key_id = NULL,
  api_key_secret = NULL,
  limit = 1e+05,
  error_on_limit = TRUE,
  api_key_creation_url = NULL
)

Arguments

query

Full URL representation of the query to perform, as a soql::soql() query object or a character string.

api_key_id

API key id to use when performing the query. Passed to .do_api_request(). Default NULL.

api_key_secret

API key secret to use when performing the query. Passed to .do_api_request(). Default NULL. #' @param limit Limit number of rows for the SODA query.

limit

Limit number of rows for the SODA query. Default 1e5.

error_on_limit

Raise an error if the number of rows returned is equal to the maximum? Default TRUE.

api_key_creation_url

The user will be warned if they fail to provide an api_key_id and api_key_secret. Provide this optional argument to direct the user to a website where they can create those credentials. See .warn_no_api_creds().