Learn R Programming

brickster

{brickster} is the R toolkit for Databricks, it includes:

Installation

remotes::install_github("databrickslabs/brickster")

Quick Start

library(brickster)

# only requires `DATABRICKS_HOST` if using OAuth U2M
# first request will open browser window to login
Sys.setenv(DATABRICKS_HOST = "https://<workspace-prefix>.cloud.databricks.com")

# list all SQL warehouses
warehouses <- db_sql_warehouse_list()

# read `data.csv` from a volume
file <- db_volume_read(
  path = "/Volumes/<catalog>/<schema>/<volume>/data.csv",
  tempfile(pattern = ".csv")
)
volume_csv <- readr::read_csv(file)

Refer to the "Connect to a Databricks Workspace" article for more details on getting authentication configured.

API Coverage

{brickster} is very deliberate with choosing what API's are wrapped. {brickster} isn't intended to replace IaC tooling (e.g. Terraform) or to be used for account/workspace administration.

APIAvailableVersion
DBFSYes2.0
SecretsYes2.0
ReposYes2.0
mlflow Model RegistryYes2.0
ClustersYes2.0
LibrariesYes2.0
WorkspaceYes2.0
EndpointsYes2.0
Query HistoryYes2.0
JobsYes2.1
Volumes (Files)Yes2.0
SQL Statement ExecutionYes2.0
REST 1.2 CommandsPartially1.2
Unity Catalog - TablesYes2.1
Unity Catalog - VolumesYes2.1
Unity CatalogPartially2.1

Copy Link

Version

Install

install.packages('brickster')

Monthly Downloads

1,004

Version

0.2.8.1

License

Apache License (>= 2)

Issues

Pull Requests

Stars

Forks

Maintainer

Zac Davies

Last Published

July 21st, 2025

Functions in brickster (0.2.8.1)

azure_attributes

Azure Attributes
db_cluster_list_zones

List Availability Zones (AWS Only)
db_cluster_perm_delete

Permanently Delete a Cluster
db_cluster_terminate

Delete/Terminate a Cluster
db_cluster_create

Create a Cluster
db_cluster_action

Cluster Action Helper Function
db_context_status

Get Information About an Execution Context
db_cluster_unpin

Unpin a Cluster
db_current_user

Get Current User Info
db_context_command_status

Get Information About a Command
db_cluster_delete

Delete/Terminate a Cluster
db_cluster_pin

Pin a Cluster
db_context_create

Create an Execution Context
db_context_command_cancel

Cancel a Command
db_current_workspace_id

Detect Current Workspace ID
db_current_cloud

Detect Current Workspaces Cloud
db_jobs_list

List Jobs
db_dbfs_add_block

DBFS Add Block
db_dbfs_close

DBFS Close
db_jobs_reset

Overwrite All Settings For A Job
condition_task

Condition Task
db_cluster_list

List Clusters
db_cluster_restart

Restart a Cluster
db_cluster_get

Get Details of a Cluster
db_cluster_resize

Resize a Cluster
cluster_log_conf

Cluster Log Configuration
db_context_manager

Databricks Execution Context Manager (R6 Class)
db_context_destroy

Delete an Execution Context
db_context_command_parse

Parse Command Results
db_dbfs_list

DBFS List
db_dbfs_get_status

DBFS Get Status
db_jobs_runs_cancel

Cancel Job Run
db_jobs_run_now

Trigger A New Job Run
db_jobs_runs_list

List Job Runs
db_mlflow_model_reject_transition_req

Reject Model Version Stage Transition Request
db_jobs_runs_submit

Create And Trigger A One-Time Run
db_jobs_runs_delete

Delete Job Run
db_jobs_runs_export

Export Job Run Output
db_dbfs_put

DBFS Put
db_dbfs_read

DBFS Read
db_mlflow_model_transition_req

Make a Model Version Stage Transition Request
db_libs_uninstall

Uninstall Library on Cluster
access_control_request

Access Control Request
db_jobs_runs_get

Get Job Run Details
add_lib_path

Add Library Path
db_dbfs_mkdirs

DBFS mkdirs
db_mlflow_model_open_transition_reqs

Get All Open Stage Transition Requests for the Model Version
db_cluster_start

Start a Cluster
db_query_list

List SQL Queries
db_query_update

Update a SQL Query
db_cluster_runtime_versions

List Available Databricks Runtime Versions
db_mlflow_model_approve_transition_req

Approve Model Version Stage Transition Request
db_mlflow_model_delete_transition_req

Delete a Model Version Stage Transition Request
db_read_netrc

Read .netrc File
db_query_delete

Delete a SQL Query
db_context_command_run

Run a Command
db_mlflow_registered_model_details

Get Registered Model Details
db_secrets_scope_acl_delete

Delete Secret Scope ACL
db_secrets_put

Put Secret in Secret Scope
db_query_get

Get a SQL Query
db_context_command_run_and_wait

Run a Command and Wait For Results
db_repo_get_all

Get All Repos
db_repl

Remote REPL to Databricks Cluster
db_repo_get

Get Repo
db_perform_request

Perform Databricks API Request
db_jobs_runs_get_output

Get Job Run Output
db_oauth_client

Create OAuth 2.0 Client
db_dbfs_create

DBFS Create
db_host

Generate/Fetch Databricks Host
db_jobs_create

Create Job
db_dbfs_delete

DBFS Delete
db_libs_all_cluster_statuses

Get Status of All Libraries on All Clusters
db_dbfs_move

DBFS Move
db_jobs_update

Partially Update A Job
db_query_create

Create a SQL Query
db_sql_exec_cancel

Cancel SQL Query
db_secrets_scope_create

Create Secret Scope
db_secrets_scope_acl_put

Put ACL on Secret Scope
db_sql_query_history

List Warehouse Query History
db_sql_query

Execute query with SQL Warehouse
db_secrets_scope_acl_get

Get Secret Scope ACL
db_secrets_scope_acl_list

List Secret Scope ACL's
db_jobs_delete

Delete a Job
db_sql_exec_query

Execute SQL Query
db_repo_update

Update Repo
db_secrets_delete

Delete Secret in Secret Scope
db_uc_schemas_list

List Schemas (Unity Catalog)
db_uc_schemas_get

Get Schema (Unity Catalog)
db_sql_exec_poll_for_success

Poll a Query Until Successful
db_sql_warehouse_list

List Warehouses
db_jobs_get

Get Job Details
db_libs_cluster_status

Get Status of Libraries on Cluster
db_mlflow_model_version_comment

Make a Comment on a Model Version
db_sql_warehouse_start

Start Warehouse
db_libs_install

Install Library on Cluster
db_uc_tables_delete

Delete Table (Unity Catalog)
db_mlflow_model_transition_stage

Transition a Model Version's Stage
db_vs_indexes_create

Create a Vector Search Index
db_vs_indexes_delete

Delete a Vector Search Index
db_uc_volumes_delete

Delete Volume (Unity Catalog)
db_uc_volumes_get

Get Volume (Unity Catalog)
db_uc_catalogs_get

Get Catalog (Unity Catalog)
db_uc_catalogs_list

List Catalogs (Unity Catalog)
db_uc_volumes_list

List Volumes (Unity Catalog)
db_secrets_list

List Secrets in Secret Scope
db_uc_volumes_update

Update Volume (Unity Catalog)
db_request_json

Generate Request JSON
db_mlflow_model_version_comment_delete

Delete a Comment on a Model Version
db_secrets_scope_delete

Delete Secret Scope
db_sql_exec_result

Get SQL Query Results
db_req_error_body

Propagate Databricks API Errors
db_uc_tables_summaries

List Table Summaries (Unity Catalog)
db_mlflow_model_version_comment_edit

Edit a Comment on a Model Version
db_repo_create

Create Repo
db_volume_file_exists

Volume FileSystem File Status
db_uc_volumes_create

Update Volume (Unity Catalog)
db_volume_list

Volume FileSystem List Directory Contents
db_repo_delete

Delete Repo
db_volume_read

Volume FileSystem Read
db_vs_indexes_query_next_page

Query Vector Search Next Page
db_volume_write

Volume FileSystem Write
db_vs_indexes_scan

Scan a Vector Search Index
db_sql_exec_status

Get SQL Query Status
determine_brickster_venv

Determine brickster virtualenv
db_request

Databricks Request Helper
db_token

Fetch Databricks Token
db_secrets_scope_list_all

List Secret Scopes
db_sql_warehouse_get

Get Warehouse
db_uc_tables_exists

Check Table Exists (Unity Catalog)
db_volume_dir_delete

Volume FileSystem Delete Directory
db_vs_endpoints_delete

Delete a Vector Search Endpoint
db_vs_indexes_sync

Synchronize a Vector Search Index
db_vs_indexes_upsert_data

Upsert Data into a Vector Search Index
db_sql_warehouse_edit

Edit Warehouse
db_workspace_mkdirs

Make a Directory (Workspaces)
db_volume_dir_exists

Volume FileSystem Check Directory Exists
db_sql_global_warehouse_get

Get Global Warehouse Config
db_workspace_list

List Directory Contents (Workspaces)
direct_access_index_spec

Delta Sync Vector Search Index Specification
db_vs_indexes_list

List Vector Search Indexes
get_and_start_cluster

Get and Start Cluster
gcp_attributes

GCP Attributes
is.access_control_req_user

Test if object is of class AccessControlRequestForUser
dbfs_storage_info

DBFS Storage Information
db_vs_indexes_delete_data

Delete Data from a Vector Search Index
db_vs_endpoints_create

Create a Vector Search Endpoint
db_volume_delete

Volume FileSystem Delete
is.embedding_source_column

Test if object is of class EmbeddingSourceColumn
db_sql_warehouse_create

Create Warehouse
db_sql_warehouse_stop

Stop Warehouse
db_volume_dir_create

Volume FileSystem Create Directory
db_uc_tables_list

List Tables (Unity Catalog)
db_uc_tables_get

Get Table (Unity Catalog)
default_config_profile

Returns the default config profile
is.condition_task

Test if object is of class ConditionTask
db_sql_warehouse_delete

Delete Warehouse
is.direct_access_index

Test if object is of class DirectAccessIndex
db_vs_endpoints_list

List Vector Search Endpoints
is.azure_attributes

Test if object is of class AzureAttributes
db_vs_endpoints_get

Get a Vector Search Endpoint
is.spark_python_task

Test if object is of class SparkPythonTask
db_vs_indexes_query

Query a Vector Search Index
db_workspace_export

Export Notebook or Directory (Workspaces)
embedding_vector_column

Embedding Vector Column
db_workspace_delete

Delete Object/Directory (Workspaces)
python_wheel_task

Python Wheel Task
delta_sync_index_spec

Delta Sync Vector Search Index Specification
is.cluster_autoscale

Test if object is of class AutoScale
is.sql_file_task

Test if object is of class SqlFileTask
db_workspace_import

Import Notebook/Directory (Workspaces)
is.access_control_request

Test if object is of class AccessControlRequest
db_workspace_get_status

Get Object Status (Workspaces)
is.job_task

Test if object is of class JobTaskSettings
is.cron_schedule

Test if object is of class CronSchedule
use_databricks_cfg

Returns whether or not to use a .databrickscfg file
file_storage_info

File Storage Information
is.dbfs_storage_info

Test if object is of class DbfsStorageInfo
is.library

Test if object is of class Library
for_each_task

For Each Task
is.docker_image

Test if object is of class DockerImage
db_vs_indexes_get

Get a Vector Search Index
is.cluster_log_conf

Test if object is of class ClusterLogConf
docker_image

Docker Image
is.access_control_req_group

Test if object is of class AccessControlRequestForGroup
email_notifications

Email Notifications
is.email_notifications

Test if object is of class JobEmailNotifications
is.libraries

Test if object is of class Libraries
is.aws_attributes

Test if object is of class AwsAttributes
is.pipeline_task

Test if object is of class PipelineTask
embedding_source_column

Embedding Source Column
is.new_cluster

Test if object is of class NewCluster
is.for_each_task

Test if object is of class ForEachTask
is.s3_storage_info

Test if object is of class S3StorageInfo
is.lib_cran

Test if object is of class CranLibrary
is.spark_jar_task

Test if object is of class SparkJarTask
s3_storage_info

S3 Storage Info
is.lib_pypi

Test if object is of class PyPiLibrary
git_source

Git Source for Job Notebook Tasks
pipeline_task

Pipeline Task
in_databricks_nb

Detect if running within Databricks Notebook
is.notebook_task

Test if object is of class NotebookTask
spark_jar_task

Spark Jar Task
is.lib_maven

Test if object is of class MavenLibrary
job_task

Job Task
db_wsid

Fetch Databricks Workspace ID
is.gcp_attributes

Test if object is of class GcpAttributes
is.lib_jar

Test if object is of class JarLibrary
init_script_info

Init Script Info
is.delta_sync_index

Test if object is of class DeltaSyncIndex
get_and_start_warehouse

Get and Start Warehouse
get_latest_dbr

Get Latest Databricks Runtime (DBR)
spark_python_task

Spark Python Task
job_tasks

Job Tasks
lib_jar

Jar Library (Scala)
remove_lib_path

Remove Library Path
is.git_source

Test if object is of class GitSource
is.lib_whl

Test if object is of class WhlLibrary
is.lib_egg

Test if object is of class EggLibrary
sql_file_task

SQL File Task
is.spark_submit_task

Test if object is of class SparkSubmitTask
is.embedding_vector_column

Test if object is of class EmbeddingVectorColumn
is.init_script_info

Test if object is of class InitScriptInfo
lib_pypi

PyPi Library (Python)
is.file_storage_info

Test if object is of class FileStorageInfo
is.valid_task_type

Test if object is of class JobTask
notebook_task

Notebook Task
is.vector_search_index_spec

Test if object is of class VectorSearchIndexSpec
new_cluster

New Cluster
libraries

Libraries
is.sql_query_task

Test if object is of class SqlQueryTask
run_job_task

Run Job Task
lib_maven

Maven Library (Scala)
open_workspace

Connect to Databricks Workspace
sql_query_task

SQL Query Task
lib_whl

Wheel Library (Python)
wait_for_lib_installs

Wait for Libraries to Install on Databricks Cluster
read_env_var

Reads Environment Variables
read_databrickscfg

Reads Databricks CLI Config
lib_cran

Cran Library (R)
is.run_job_task

Test if object is of class RunJobTask
spark_submit_task

Spark Submit Task
is.python_wheel_task

Test if object is of class PythonWheelTask
lib_egg

Egg Library (Python)
cluster_autoscale

Cluster Autoscale
access_control_req_group

Access Control Request for Group
aws_attributes

AWS Attributes
access_control_req_user

Access Control Request For User
close_workspace

Close Databricks Workspace Connection
cron_schedule

Cron Schedule
db_cluster_list_node_types

List Available Cluster Node Types
db_cluster_edit

Edit a Cluster
db_cluster_events

List Cluster Activity Events