db_sql_query {brickster} | R Documentation |
Execute query with SQL Warehouse
Description
Execute query with SQL Warehouse
Usage
db_sql_query(
warehouse_id,
statement,
schema = NULL,
catalog = NULL,
parameters = NULL,
row_limit = NULL,
byte_limit = NULL,
return_arrow = FALSE,
max_active_connections = 30,
host = db_host(),
token = db_token()
)
Arguments
warehouse_id |
String, ID of warehouse upon which to execute a statement. |
statement |
String, the SQL statement to execute. The statement can
optionally be parameterized, see |
schema |
String, sets default schema for statement execution, similar
to |
catalog |
String, sets default catalog for statement execution, similar
to |
parameters |
List of Named Lists, parameters to pass into a SQL statement containing parameter markers. A parameter consists of a name, a value, and optionally a type.
To represent a See docs for more details. |
row_limit |
Integer, applies the given row limit to the statement's
result set, but unlike the |
byte_limit |
Integer, applies the given byte limit to the statement's
result size. Byte counts are based on internal data representations and
might not match the final size in the requested format. If the result was
truncated due to the byte limit, then |
return_arrow |
Boolean, determine if result is tibble::tibble or arrow::Table. |
max_active_connections |
Integer to decide on concurrent downloads. |
host |
Databricks workspace URL, defaults to calling |
token |
Databricks workspace token, defaults to calling |
Value
tibble::tibble or arrow::Table.