Databricks icon

Databricks

Interact with Databricks API

Unity Catalog → List Volumes

AI-generated

Overview

This node operation lists volumes within the Unity Catalog in Databricks. It allows filtering volumes by catalog and schema names optionally. This is useful for users who want to retrieve and manage storage volumes in their Databricks Unity Catalog environment, enabling them to see available volumes under specific catalogs and schemas.

Use Case Examples

  1. List all volumes across all catalogs and schemas.
  2. List volumes filtered by a specific catalog name.
  3. List volumes filtered by both catalog and schema names.

Properties

Name Meaning
Catalog Optional filter to specify the catalog name to list volumes from. If left empty, volumes from all catalogs are listed.
Schema Optional filter to specify the schema name within the selected catalog to list volumes from. Requires catalog to be specified. If left empty, volumes from all schemas in the catalog are listed.

Output

JSON

  • volumes - Array of volume objects returned by the Unity Catalog API, each representing a volume with details such as name, description, and type.

Dependencies

  • Databricks API with appropriate authentication token
  • Unity Catalog API endpoints

Troubleshooting

  • Ensure the catalog and schema names are correctly specified and exist in the Unity Catalog.
  • Check that the API authentication token is valid and has permissions to access Unity Catalog resources.
  • If no volumes are returned, verify that volumes exist under the specified catalog and schema.
  • Handle API errors gracefully, such as network issues or permission denials.

Links

Discussion