db_volume_list: Volume FileSystem List Directory Contents

In brickster: R Toolkit for 'Databricks'

Volume FileSystem List Directory Contents

Description

Volume FileSystem List Directory Contents

Usage

db_volume_list(
  path,
  host = db_host(),
  token = db_token(),
  perform_request = TRUE,
  page_size = NULL,
  page_token = NULL
)

Arguments

path	Absolute path of the file in the Files API, omitting the initial slash.
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.
page_size	Maximum number of directory entries per page, from 0 to 1000. NULL uses the API default; 0 requests the maximum page size.
page_token	Continuation token from a previous response, or NULL for the first page.

Value

If perform_request = TRUE, returns one API response page, including contents and next_page_token when present. If FALSE, returns an httr2_request. Directory download and recursive-delete helpers fetch all pages.

See Also

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

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