query_civis_file {civis}R Documentation

Export results from a query to S3 and return a file id.

Description

Exports results from a Redshift SQL query, and returns the id of the file on S3 for use with read_civis or download_civis.

Usage

query_civis_file(x, ...)

## S3 method for class 'character'
query_civis_file(
  x,
  database = NULL,
  job_name = NULL,
  hidden = TRUE,
  verbose = verbose,
  csv_settings = NULL,
  ...
)

## S3 method for class 'sql'
query_civis_file(
  x,
  database = NULL,
  job_name = NULL,
  hidden = TRUE,
  verbose = FALSE,
  csv_settings = NULL,
  ...
)

## S3 method for class 'numeric'
query_civis_file(x, database = NULL, verbose = FALSE, ...)

Arguments

x

"schema.table", sql("query"), or a sql script job id.

...

Options passed to scripts_post_sql, including credential.

database

string, Name of database where data frame is to be uploaded. If no database is specified, uses options(civis.default_db).

job_name

string, Name of the job (default: "Civis S3 Export Via R Client").

hidden

bool, Whether the job is hidden.

verbose

bool, Set to TRUE to print intermediate progress indicators.

csv_settings

See scripts_post_sql for details.

Details

By default, the export uses the default csv_settings in scripts_post_sql, which is a gzipped csv.

Methods (by class)

See Also

Other io: download_civis(), query_civis(), read_civis(), write_civis_file(), write_civis()

Examples

## Not run: 
id <- query_civis_file("schema.tablename", database = "my_database")
df <- read_civis(id, using = read.csv)

query <- sql("SELECT * FROM table JOIN other_table USING id WHERE var1 < 23")
id <- query_civis_file(query)
df <- read_civis(id, using = read.csv)

id <- query_civis_file(query_id, credential_id = 0000)
df <- read_civis(id, using = read.csv)

## End(Not run)

[Package civis version 3.0.0 Index]