List Volumes. — list_volumes • databricks

Gets an array of volumes for the current metastore under the parent catalog and schema.

Usage

list_volumes(
  client,
  catalog_name,
  schema_name,
  include_browse = NULL,
  max_results = NULL,
  page_token = NULL
)

volumesList(
  client,
  catalog_name,
  schema_name,
  include_browse = NULL,
  max_results = NULL,
  page_token = NULL
)

Arguments

client: Required. Instance of DatabricksClient()
catalog_name: Required. The identifier of the catalog.
schema_name: Required. The identifier of the schema.
include_browse: Whether to include volumes in the response for which the principal can only access selective metadata for.
max_results: Maximum number of volumes to return (page length).
page_token: Opaque token returned by a previous request.

Value

data.frame with all of the response pages.

Details

The returned volumes are filtered based on the privileges of the calling user. For example, the metastore admin is able to list all the volumes. A regular user needs to be the owner or have the READ VOLUME privilege on the volume to recieve the volumes in the response. For the latter case, the caller must also be the owner or have the USE_CATALOG privilege on the parent catalog and the USE_SCHEMA privilege on the parent schema.

There is no guarantee of a specific ordering of the elements in the array.