run_query: Convenience method to execute a SQL query optionally...

In nurseshealthstudy/Nurses: Convenience methods for working with Nurses Health Study data

Description

This function is a wrapper for the bigrquery::bq_project_query() and bigrquery::bq_table_download() functions from the bigrquery package changing a few of the default values for parameters. See the documentation and vignettes of that package to learn how to use bigrquery. It also makes use of stringr::str_glue() to format and interpolate the SQL string passed in, if any of it needed to be interpolated using values from the global environment. See the documentation and vignettes of the stringr package for more detail.

Usage

run_query(query, project, page_size = 5000, max_pages = Inf)

Arguments

query	SQL query string optionally containing code to be interpolated
project	The billing project name, a string.
page_size	The number of rows returned per page. Make this smaller if you have many fields or large records and you are seeing a 'responseTooLarge' error.
max_pages	Maximum number of results to retrieve. Defaults to Inf to retrieve all rows.

Details

Troubleshooting tips

• If you get 'Error: Requested Resource Too Large to Return responseTooLarge', reduce the value of the page_size parameter.

• If you get 'Error: Exceeded rate limits: Your project: ### exceeded quota for tabledata.list bytes per second per project. rateLimitExceeded' or 'Error: Error encountered during execution. Retrying may solve the problem. backendError' increase the value of the page_size parameter.

See Also

bigrquery::bq_project_query(), browseVignettes("bigrquery")

bigrquery::bq_table_download(), browseVignettes("bigrquery")

stringr::str_glue(), browseVignettes("stringr")

Examples

## Not run: 

BILLING_PROJECT <- 'my-cloud-project'
TABLE <- 'genomics-public-data.1000_genomes.sample_info'
df <- run_query('SELECT Sample, Gender, Super_Population FROM `{TABLE}`',
                project = BILLING_PROJECT)


## End(Not run)

nurseshealthstudy/Nurses documentation built on May 14, 2019, 3:08 a.m.