db_sql_query: Execute query with SQL Warehouse

In zacdav-db/brickster: R Toolkit for 'Databricks'

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 parameters.
schema	String, sets default schema for statement execution, similar to ⁠USE SCHEMA⁠ in SQL.
catalog	String, sets default catalog for statement execution, similar to ⁠USE CATALOG⁠ in SQL.
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 NULL value, the value field may be omitted or set to NULL explicitly. See docs for more details.
row_limit	Integer, applies the given row limit to the statement's result set, but unlike the LIMIT clause in SQL, it also sets the truncated field in the response to indicate whether the result was trimmed due to the limit or not.
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 truncated in the response is set to true. When using EXTERNAL_LINKS disposition, a default byte_limit of 100 GiB is applied if byte_limit is not explicitly set.
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 db_host().
token	Databricks workspace token, defaults to calling db_token().

Value

tibble::tibble or arrow::Table.

zacdav-db/brickster documentation built on June 13, 2025, 2:39 p.m.