Skip to contents

Bulk Delete Folders from a Databrary Volume

Source: R/bulk_folders.R
bulk_delete_folders.Rd

Soft-delete many folders from a single volume sequentially.

Usage

bulk_delete_folders(
  vol_id = 1,
  folder_ids,
  vb = options::opt("vb"),
  rq = NULL,
  on_error = c("stop", "collect"),
  max_retries = 0L,
  retry_delay = 0
)

Arguments

vol_id

Target volume number. Must be a positive integer.

folder_ids

Numeric vector of folder identifiers. Must be positive integers.

vb

Show verbose messages. (Defaults to FALSE, overwritable using option 'databraryr.vb' or environment variable 'R_DATABRARYR_VB')

rq

An httr2 request object. Defaults to NULL.

on_error

"stop" or "collect"; see bulk_upload_files.

max_retries

Non-negative integer; extra attempts per input after the first failure.

retry_delay

Seconds between retries.

Value

A tibble as documented in bulk_upload_files.

See also

delete_folder, resume_bulk

Examples

# \donttest{
if (FALSE) { # \dontrun{
bulk_delete_folders(vol_id = 1, folder_ids = c(11, 12, 13))
} # }
# }