db_sql_exec_query {brickster} | R Documentation |
Execute SQL Query
Description
Execute SQL Query
Usage
db_sql_exec_query(
statement,
warehouse_id,
catalog = NULL,
schema = NULL,
parameters = NULL,
row_limit = NULL,
byte_limit = NULL,
disposition = c("INLINE", "EXTERNAL_LINKS"),
format = c("JSON_ARRAY", "ARROW_STREAM", "CSV"),
wait_timeout = "10s",
on_wait_timeout = c("CONTINUE", "CANCEL"),
host = db_host(),
token = db_token(),
perform_request = TRUE
)
Arguments
statement |
String, the SQL statement to execute. The statement can
optionally be parameterized, see |
warehouse_id |
String, ID of warehouse upon which to execute a statement. |
catalog |
String, sets default catalog for statement execution, similar
to |
schema |
String, sets default schema 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 |
disposition |
One of |
format |
One of |
wait_timeout |
String, default is When set between If the statement takes longer to execute, |
on_wait_timeout |
One of When set to When set to |
host |
Databricks workspace URL, defaults to calling |
token |
Databricks workspace token, defaults to calling |
perform_request |
If |
Details
Refer to the web documentation for detailed material on interaction of the various parameters and general recommendations
See Also
Other SQL Execution APIs:
db_sql_exec_cancel()
,
db_sql_exec_result()
,
db_sql_exec_status()