libraries_uninstall: Uninstall Packages (libraries) on a Databricks Cluster

View source: R/libraries_uninstall.R

libraries_uninstallR Documentation

Uninstall Packages (libraries) on a Databricks Cluster

Description

Set libraries to be uninstalled on a cluster. The libraries aren’t uninstalled until the cluster is restarted. Uninstalling libraries that are not installed on the cluster has no impact but is not an error. You can locate the cluster ID in the URL of the cluster configuration page. For example:

Usage

libraries_uninstall(
  cluster_id,
  package,
  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 uninstall.

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 uninstalling libraries is '2.0/libraries/uninstall'. 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"

# Uninstall package
libraries_uninstall(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.