db_volume_dir_delete: Volume FileSystem Delete Directory

In brickster: R Toolkit for 'Databricks'

Volume FileSystem Delete Directory

Description

Volume FileSystem Delete Directory

Usage

db_volume_dir_delete(
  path,
  recursive = FALSE,
  verbose = FALSE,
  host = db_host(),
  token = db_token(),
  perform_request = TRUE
)

Arguments

path	Absolute path of the file in the Files API, omitting the initial slash.
recursive	If TRUE, recursively delete directory contents (default: FALSE) after listing every page of each directory. Listing failures stop traversal before deleting that directory's contents; earlier directories may already have been processed.
verbose	If TRUE, announce each file/directory deletion (default: FALSE)
host	Databricks workspace URL, defaults to calling db_host().
token	Databricks workspace token, defaults to calling db_token().
perform_request	If TRUE (default) the request is performed, if FALSE the httr2 request is returned without being performed.

Value

If perform_request = TRUE, returns a logical success flag. If FALSE, returns an httr2_request to delete only the directory itself. Directory contents are not listed or deleted, even when recursive = TRUE.

See Also

Other Volumes FileSystem API: db_volume_delete(), db_volume_dir_create(), db_volume_dir_exists(), db_volume_download_dir(), db_volume_file_exists(), db_volume_list(), db_volume_read(), db_volume_upload_dir(), db_volume_write()

brickster documentation built on Oct. 9, 2026, 5:07 p.m.