Package: brickster 0.2.5

Zac Davies

brickster: R Toolkit for 'Databricks'

Collection of utilities that improve using 'Databricks' from R. Primarily functions that wrap specific 'Databricks' APIs (<https://docs.databricks.com/api>), 'RStudio' connection pane support, quality of life functions to make 'Databricks' simpler to use.

Authors:Zac Davies [aut, cre], Rafi Kurlansik [aut], Databricks [cph, fnd]

brickster_0.2.5.tar.gz
brickster_0.2.5.tar.gz(r-4.5-noble)brickster_0.2.5.tar.gz(r-4.4-noble)
brickster_0.2.5.tgz(r-4.4-emscripten)brickster_0.2.5.tgz(r-4.3-emscripten)
brickster.pdf |brickster.html✨
brickster/json (API)
NEWS

# Install 'brickster' in R:
install.packages('brickster', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/databrickslabs/brickster/issues

3.68 score 24 scripts 214 exports 39 dependencies

Last updated 4 days agofrom:27ea65da9f. Checks:OK: 2. Indexed: no.

TargetResultDate
Doc / VignettesOKNov 14 2024
R-4.5-linuxOKNov 14 2024

Exports:access_control_req_groupaccess_control_req_useraccess_control_requestadd_lib_pathaws_attributesazure_attributesclose_workspacecluster_autoscalecluster_log_confcron_scheduleDatabricksSqlClientdb_cluster_createdb_cluster_deletedb_cluster_editdb_cluster_eventsdb_cluster_getdb_cluster_listdb_cluster_list_node_typesdb_cluster_list_zonesdb_cluster_perm_deletedb_cluster_pindb_cluster_resizedb_cluster_restartdb_cluster_runtime_versionsdb_cluster_startdb_cluster_terminatedb_cluster_unpindb_context_command_canceldb_context_command_rundb_context_command_run_and_waitdb_context_command_statusdb_context_createdb_context_destroydb_context_managerdb_context_statusdb_current_clouddb_current_userdb_current_workspace_iddb_dbfs_add_blockdb_dbfs_closedb_dbfs_createdb_dbfs_deletedb_dbfs_get_statusdb_dbfs_listdb_dbfs_mkdirsdb_dbfs_movedb_dbfs_putdb_dbfs_readdb_hostdb_jobs_createdb_jobs_deletedb_jobs_getdb_jobs_listdb_jobs_resetdb_jobs_run_nowdb_jobs_runs_canceldb_jobs_runs_deletedb_jobs_runs_exportdb_jobs_runs_getdb_jobs_runs_get_outputdb_jobs_runs_listdb_jobs_runs_submitdb_jobs_updatedb_libs_all_cluster_statusesdb_libs_cluster_statusdb_libs_installdb_libs_uninstalldb_mlflow_model_approve_transition_reqdb_mlflow_model_delete_transition_reqdb_mlflow_model_open_transition_reqsdb_mlflow_model_reject_transition_reqdb_mlflow_model_transition_reqdb_mlflow_model_transition_stagedb_mlflow_model_version_commentdb_mlflow_model_version_comment_deletedb_mlflow_model_version_comment_editdb_mlflow_registered_model_detailsdb_read_netrcdb_repldb_repo_createdb_repo_deletedb_repo_getdb_repo_get_alldb_repo_updatedb_request_jsondb_secrets_deletedb_secrets_listdb_secrets_putdb_secrets_scope_acl_deletedb_secrets_scope_acl_getdb_secrets_scope_acl_listdb_secrets_scope_acl_putdb_secrets_scope_createdb_secrets_scope_deletedb_secrets_scope_list_alldb_sql_clientdb_sql_exec_canceldb_sql_exec_querydb_sql_exec_resultdb_sql_exec_statusdb_sql_global_warehouse_getdb_sql_query_historydb_sql_warehouse_createdb_sql_warehouse_deletedb_sql_warehouse_editdb_sql_warehouse_getdb_sql_warehouse_listdb_sql_warehouse_startdb_sql_warehouse_stopdb_tokendb_volume_deletedb_volume_dir_createdb_volume_dir_deletedb_volume_dir_existsdb_volume_file_existsdb_volume_listdb_volume_readdb_volume_writedb_vs_endpoints_createdb_vs_endpoints_deletedb_vs_endpoints_getdb_vs_endpoints_listdb_vs_indexes_createdb_vs_indexes_deletedb_vs_indexes_delete_datadb_vs_indexes_getdb_vs_indexes_listdb_vs_indexes_querydb_vs_indexes_query_next_pagedb_vs_indexes_scandb_vs_indexes_syncdb_vs_indexes_upsert_datadb_workspace_deletedb_workspace_exportdb_workspace_get_statusdb_workspace_importdb_workspace_listdb_workspace_mkdirsdb_wsiddbfs_storage_infodelta_sync_index_specdirect_access_index_specdocker_imageemail_notificationsembedding_source_columnembedding_vector_columnfile_storage_infogcp_attributesget_and_start_clusterget_and_start_warehouseget_latest_dbrgit_sourcein_databricks_nbinit_script_infoinstall_db_sql_connectoris.access_control_req_groupis.access_control_req_useris.access_control_requestis.aws_attributesis.azure_attributesis.cluster_autoscaleis.cluster_log_confis.cron_scheduleis.dbfs_storage_infois.delta_sync_indexis.direct_access_indexis.docker_imageis.email_notificationsis.embedding_source_columnis.embedding_vector_columnis.file_storage_infois.gcp_attributesis.git_sourceis.init_script_infois.job_taskis.lib_cranis.lib_eggis.lib_jaris.lib_mavenis.lib_pypiis.lib_whlis.librariesis.libraryis.new_clusteris.notebook_taskis.pipeline_taskis.python_wheel_taskis.s3_storage_infois.spark_jar_taskis.spark_python_taskis.spark_submit_taskis.valid_task_typeis.vector_search_index_specjob_taskjob_taskslib_cranlib_egglib_jarlib_mavenlib_pypilib_whllibrariesnew_clusternotebook_taskopen_workspacepipeline_taskpy_db_sql_connectorpython_wheel_taskremove_lib_paths3_storage_infospark_jar_taskspark_python_taskspark_submit_taskwait_for_lib_installs

Dependencies:arrowaskpassassertthatbase64encbitbit64clicpp11curldplyrfansigenericsglueherehttr2inijsonlitelatticelifecyclemagrittrMatrixopensslpillarpkgconfigpngpurrrR6rappdirsRcppRcppTOMLreticulaterlangrprojrootsystibbletidyselectutf8vctrswithr

Cluster Management

Rendered fromcluster-management.Rmdusingknitr::rmarkdownon Nov 14 2024.

Last update: 2024-11-13
Started: 2024-11-13

Connect to a Databricks Workspace

Rendered fromsetup-auth.Rmdusingknitr::rmarkdownon Nov 14 2024.

Last update: 2024-11-13
Started: 2024-11-13

Databricks REPL

Rendered fromremote-repl.Rmdusingknitr::rmarkdownon Nov 14 2024.

Last update: 2024-11-13
Started: 2024-11-13

Job Management

Rendered frommanaging-jobs.Rmdusingknitr::rmarkdownon Nov 14 2024.

Last update: 2024-11-13
Started: 2024-11-13

Readme and manuals

Help Manual

Help pageTopics
Access Control Request for Groupaccess_control_req_group
Access Control Request For Useraccess_control_req_user
Access Control Requestaccess_control_request
Add Library Pathadd_lib_path
AWS Attributesaws_attributes
Azure Attributesazure_attributes
Close Databricks Workspace Connectionclose_workspace
Cluster Autoscalecluster_autoscale
Cluster Log Configurationcluster_log_conf
Cron Schedulecron_schedule
Databricks SQL ConnectorDatabricksSqlClient
Cluster Action Helper Functiondb_cluster_action
Create a Clusterdb_cluster_create
Delete/Terminate a Clusterdb_cluster_delete
Edit a Clusterdb_cluster_edit
List Cluster Activity Eventsdb_cluster_events
Get Details of a Clusterdb_cluster_get
List Clustersdb_cluster_list
List Available Cluster Node Typesdb_cluster_list_node_types
List Availability Zones (AWS Only)db_cluster_list_zones
Permanently Delete a Clusterdb_cluster_perm_delete
Pin a Clusterdb_cluster_pin
Resize a Clusterdb_cluster_resize
Restart a Clusterdb_cluster_restart
List Available Databricks Runtime Versionsdb_cluster_runtime_versions
Start a Clusterdb_cluster_start
Delete/Terminate a Clusterdb_cluster_terminate
Unpin a Clusterdb_cluster_unpin
Cancel a Commanddb_context_command_cancel
Run a Commanddb_context_command_run
Run a Command and Wait For Resultsdb_context_command_run_and_wait
Get Information About a Commanddb_context_command_status
Create an Execution Contextdb_context_create
Delete an Execution Contextdb_context_destroy
Databricks Execution Context Manager (R6 Class)db_context_manager
Get Information About an Execution Contextdb_context_status
Detect Current Workspaces Clouddb_current_cloud
Get Current User Infodb_current_user
Detect Current Workspace IDdb_current_workspace_id
DBFS Add Blockdb_dbfs_add_block
DBFS Closedb_dbfs_close
DBFS Createdb_dbfs_create
DBFS Deletedb_dbfs_delete
DBFS Get Statusdb_dbfs_get_status
DBFS Listdb_dbfs_list
DBFS mkdirsdb_dbfs_mkdirs
DBFS Movedb_dbfs_move
DBFS Putdb_dbfs_put
DBFS Readdb_dbfs_read
Generate/Fetch Databricks Hostdb_host
Create Jobdb_jobs_create
Delete a Jobdb_jobs_delete
Get Job Detailsdb_jobs_get
List Jobsdb_jobs_list
Overwrite All Settings For A Jobdb_jobs_reset
Trigger A New Job Rundb_jobs_run_now
Cancel Job Rundb_jobs_runs_cancel
Delete Job Rundb_jobs_runs_delete
Export Job Run Outputdb_jobs_runs_export
Get Job Run Detailsdb_jobs_runs_get
Get Job Run Outputdb_jobs_runs_get_output
List Job Runsdb_jobs_runs_list
Create And Trigger A One-Time Rundb_jobs_runs_submit
Partially Update A Jobdb_jobs_update
Get Status of All Libraries on All Clustersdb_libs_all_cluster_statuses
Get Status of Libraries on Clusterdb_libs_cluster_status
Install Library on Clusterdb_libs_install
Uninstall Library on Clusterdb_libs_uninstall
Approve Model Version Stage Transition Requestdb_mlflow_model_approve_transition_req
Delete a Model Version Stage Transition Requestdb_mlflow_model_delete_transition_req
Get All Open Stage Transition Requests for the Model Versiondb_mlflow_model_open_transition_reqs
Reject Model Version Stage Transition Requestdb_mlflow_model_reject_transition_req
Make a Model Version Stage Transition Requestdb_mlflow_model_transition_req
Transition a Model Version's Stagedb_mlflow_model_transition_stage
Make a Comment on a Model Versiondb_mlflow_model_version_comment
Delete a Comment on a Model Versiondb_mlflow_model_version_comment_delete
Edit a Comment on a Model Versiondb_mlflow_model_version_comment_edit
Get Registered Model Detailsdb_mlflow_registered_model_details
Perform Databricks API Requestdb_perform_request
Read .netrc Filedb_read_netrc
Remote REPL to Databricks Clusterdb_repl
Create Repodb_repo_create
Delete Repodb_repo_delete
Get Repodb_repo_get
Get All Reposdb_repo_get_all
Update Repodb_repo_update
Propagate Databricks API Errorsdb_req_error_body
Databricks Request Helperdb_request
Generate Request JSONdb_request_json
Delete Secret in Secret Scopedb_secrets_delete
List Secrets in Secret Scopedb_secrets_list
Put Secret in Secret Scopedb_secrets_put
Delete Secret Scope ACLdb_secrets_scope_acl_delete
Get Secret Scope ACLdb_secrets_scope_acl_get
List Secret Scope ACL'sdb_secrets_scope_acl_list
Put ACL on Secret Scopedb_secrets_scope_acl_put
Create Secret Scopedb_secrets_scope_create
Delete Secret Scopedb_secrets_scope_delete
List Secret Scopesdb_secrets_scope_list_all
Create Databricks SQL Connector Clientdb_sql_client
Cancel SQL Querydb_sql_exec_cancel
Execute SQL Querydb_sql_exec_query
Get SQL Query Resultsdb_sql_exec_result
Get SQL Query Statusdb_sql_exec_status
Get Global Warehouse Configdb_sql_global_warehouse_get
List Warehouse Query Historydb_sql_query_history
Create Warehousedb_sql_warehouse_create
Delete Warehousedb_sql_warehouse_delete
Edit Warehousedb_sql_warehouse_edit
Get Warehousedb_sql_warehouse_get
List Warehousesdb_sql_warehouse_list
Start Warehousedb_sql_warehouse_start
Stop Warehousedb_sql_warehouse_stop
Fetch Databricks Tokendb_token
Volume FileSystem Deletedb_volume_delete
Volume FileSystem Create Directorydb_volume_dir_create
Volume FileSystem Delete Directorydb_volume_dir_delete
Volume FileSystem Check Directory Existsdb_volume_dir_exists
Volume FileSystem File Statusdb_volume_file_exists
Volume FileSystem List Directory Contentsdb_volume_list
Volume FileSystem Readdb_volume_read
Volume FileSystem Writedb_volume_write
Create a Vector Search Endpointdb_vs_endpoints_create
Delete a Vector Search Endpointdb_vs_endpoints_delete
Get a Vector Search Endpointdb_vs_endpoints_get
List Vector Search Endpointsdb_vs_endpoints_list
Create a Vector Search Indexdb_vs_indexes_create
Delete a Vector Search Indexdb_vs_indexes_delete
Delete Data from a Vector Search Indexdb_vs_indexes_delete_data
Get a Vector Search Indexdb_vs_indexes_get
List Vector Search Indexesdb_vs_indexes_list
Query a Vector Search Indexdb_vs_indexes_query
Query Vector Search Next Pagedb_vs_indexes_query_next_page
Scan a Vector Search Indexdb_vs_indexes_scan
Synchronize a Vector Search Indexdb_vs_indexes_sync
Upsert Data into a Vector Search Indexdb_vs_indexes_upsert_data
Delete Object/Directory (Workspaces)db_workspace_delete
Export Notebook or Directory (Workspaces)db_workspace_export
Get Object Status (Workspaces)db_workspace_get_status
Import Notebook/Directory (Workspaces)db_workspace_import
List Directory Contents (Workspaces)db_workspace_list
Make a Directory (Workspaces)db_workspace_mkdirs
Fetch Databricks Workspace IDdb_wsid
DBFS Storage Informationdbfs_storage_info
Delta Sync Vector Search Index Specificationdelta_sync_index_spec
Delta Sync Vector Search Index Specificationdirect_access_index_spec
Docker Imagedocker_image
Email Notificationsemail_notifications
Embedding Source Columnembedding_source_column
Embedding Vector Columnembedding_vector_column
File Storage Informationfile_storage_info
GCP Attributesgcp_attributes
Get and Start Clusterget_and_start_cluster
Get and Start Warehouseget_and_start_warehouse
Get Latest Databricks Runtime (DBR)get_latest_dbr
Git Source for Job Notebook Tasksgit_source
Detect if running within Databricks Notebookin_databricks_nb
Init Script Infoinit_script_info
Install Databricks SQL Connector (Python)install_db_sql_connector
Test if object is of class AccessControlRequestForGroupis.access_control_req_group
Test if object is of class AccessControlRequestForUseris.access_control_req_user
Test if object is of class AccessControlRequestis.access_control_request
Test if object is of class AwsAttributesis.aws_attributes
Test if object is of class AzureAttributesis.azure_attributes
Test if object is of class AutoScaleis.cluster_autoscale
Test if object is of class ClusterLogConfis.cluster_log_conf
Test if object is of class CronScheduleis.cron_schedule
Test if object is of class DbfsStorageInfois.dbfs_storage_info
Test if object is of class DeltaSyncIndexis.delta_sync_index
Test if object is of class DirectAccessIndexis.direct_access_index
Test if object is of class DockerImageis.docker_image
Test if object is of class JobEmailNotificationsis.email_notifications
Test if object is of class EmbeddingSourceColumnis.embedding_source_column
Test if object is of class EmbeddingVectorColumnis.embedding_vector_column
Test if object is of class FileStorageInfois.file_storage_info
Test if object is of class GcpAttributesis.gcp_attributes
Test if object is of class GitSourceis.git_source
Test if object is of class InitScriptInfois.init_script_info
Test if object is of class JobTaskSettingsis.job_task
Test if object is of class CranLibraryis.lib_cran
Test if object is of class EggLibraryis.lib_egg
Test if object is of class JarLibraryis.lib_jar
Test if object is of class MavenLibraryis.lib_maven
Test if object is of class PyPiLibraryis.lib_pypi
Test if object is of class WhlLibraryis.lib_whl
Test if object is of class Librariesis.libraries
Test if object is of class Libraryis.library
Test if object is of class NewClusteris.new_cluster
Test if object is of class NotebookTaskis.notebook_task
Test if object is of class PipelineTaskis.pipeline_task
Test if object is of class PythonWheelTaskis.python_wheel_task
Test if object is of class S3StorageInfois.s3_storage_info
Test if object is of class SparkJarTaskis.spark_jar_task
Test if object is of class SparkPythonTaskis.spark_python_task
Test if object is of class SparkSubmitTaskis.spark_submit_task
Test if object is of class JobTaskis.valid_task_type
Test if object is of class VectorSearchIndexSpecis.vector_search_index_spec
Job Taskjob_task
Job Tasksjob_tasks
Cran Library (R)lib_cran
Egg Library (Python)lib_egg
Jar Library (Scala)lib_jar
Maven Library (Scala)lib_maven
PyPi Library (Python)lib_pypi
Wheel Library (Python)lib_whl
Librarieslibraries
New Clusternew_cluster
Notebook Tasknotebook_task
Connect to Databricks Workspaceopen_workspace
Pipeline Taskpipeline_task
Python Wheel Taskpython_wheel_task
Remove Library Pathremove_lib_path
S3 Storage Infos3_storage_info
Spark Jar Taskspark_jar_task
Spark Python Taskspark_python_task
Spark Submit Taskspark_submit_task
Wait for Libraries to Install on Databricks Clusterwait_for_lib_installs