Execute a SQL statement.
execute_statement.Rd
Execute a SQL statement.
Usage
execute_statement(
client,
statement,
warehouse_id,
byte_limit = NULL,
catalog = NULL,
disposition = NULL,
format = NULL,
on_wait_timeout = NULL,
parameters = NULL,
row_limit = NULL,
schema = NULL,
wait_timeout = NULL
)
statementExecutionExecuteStatement(
client,
statement,
warehouse_id,
byte_limit = NULL,
catalog = NULL,
disposition = NULL,
format = NULL,
on_wait_timeout = NULL,
parameters = NULL,
row_limit = NULL,
schema = NULL,
wait_timeout = NULL
)
Arguments
- client
Required. Instance of DatabricksClient()
- statement
Required. The SQL statement to execute.
- warehouse_id
Required. Warehouse upon which to execute a statement.
- byte_limit
Applies the given byte limit to the statement's result size.
- catalog
Sets default catalog for statement execution, similar to
USE CATALOG
in SQL.- disposition
The fetch disposition provides two modes of fetching results:
INLINE
andEXTERNAL_LINKS
.- format
Statement execution supports three result formats:
JSON_ARRAY
(default),ARROW_STREAM
, andCSV
.- on_wait_timeout
When
wait_timeout > 0s
, the call will block up to the specified time.- parameters
A list of parameters to pass into a SQL statement containing parameter markers.
- row_limit
Applies the given row limit to the statement's result set, but unlike the
LIMIT
clause in SQL, it also sets thetruncated
field in the response to indicate whether the result was trimmed due to the limit or not.- schema
Sets default schema for statement execution, similar to
USE SCHEMA
in SQL.- wait_timeout
The time in seconds the call will wait for the statement's result set as
Ns
, whereN
can be set to 0 or to a value between 5 and 50.