libraries_install: Install Packages (libraries) on a Databricks Cluster

In RafiKurlansik/bricksteR: R Package for Making Databricks Easy to Use.

Install Packages (libraries) on a Databricks Cluster

Description

Packages installed this way will be added to the cluster configuration going forward. When you restart the cluster they will show up in the UI. Cluster cannot be in a terminated state to use this function. You can locate the cluster ID in the URL of the cluster configuration page. For example:

Usage

libraries_install(
  cluster_id,
  package,
  repo = "https://packagemanager.rstudio.com/all/__linux__/xenial/latest",
  workspace,
  token = NULL,
  verbose = T,
  ...
)

Arguments

cluster_id	A string containing the unique id for an online Databricks cluster.
package	A string with the name of the package to install.
repo	A string representing the repo hosting the package. Defaults to RStudio Public Package Manager (https://packagemanager.rstudio.com/all/__linux__/xenial/latest) for R packages.
workspace	A string representing the web workspace of your Databricks instance. E.g., "https://eastus2.azuredatabricks.net" or "https://demo.cloud.databricks.com".
token	A valid authentication token generated via User Settings in Databricks or via the Databricks REST API 2.0. If none is provided, netrc will be used.
verbose	If TRUE, will print the API response to the console. Defaults to FALSE.

Details

https://mycompany.cloud.databricks.com/#/setting/clusters/xxxx-xxxxx-xxxxxx/

Where xxxx-xxxxx-xxxxxx is the cluster ID.

The API endpoint for installing libraries is '2.0/libraries/install'. For all details on API calls please see the official documentation at https://docs.databricks.com/dev-tools/api/latest/.

Value

The API response.

Examples

# Cluster to install on
workspace <- "https://mydb.cloud.databricks.com"
cluster_id <- "0818-155203-cheese22"

# Install package
libraries_install(package = "broom", cluster_id, workspace)

# Check installation status
get_library_statuses(cluster_id, workspace)

RafiKurlansik/bricksteR documentation built on Oct. 13, 2022, 6:58 a.m.