Databricks icon

Databricks

Interact with Databricks API

Overview

This node integrates with the Databricks API, specifically providing functionality to interact with the Unity Catalog resource. The "List Volumes" operation retrieves a list of volumes within a specified catalog and schema in the Unity Catalog. This is useful for users who want to programmatically explore or manage data storage volumes organized under different catalogs and schemas in their Databricks environment.

Practical examples include:

  • Automating inventory of data volumes for auditing or reporting.
  • Dynamically fetching available volumes to feed into downstream workflows.
  • Integrating volume metadata retrieval as part of a larger data pipeline orchestration.

Properties

Name Meaning
Catalog The catalog to use for the query. Specifies which catalog's volumes to list.
Schema The schema to use for the query. Specifies which schema within the catalog to target.

Output

The node outputs JSON data representing the list of volumes retrieved from the specified catalog and schema in the Unity Catalog. Each item in the output typically contains metadata about a volume such as its name, ID, and possibly other descriptive attributes depending on the API response.

If the node supports binary data output (not evident from the provided code), it would represent any associated binary content related to volumes, but this is unlikely for a listing operation.

Dependencies

  • Requires an active connection to a Databricks workspace via an API token credential.
  • The node expects the user to provide valid host URL and authentication token credentials configured in n8n.
  • The Unity Catalog feature must be enabled and accessible in the connected Databricks environment.

Troubleshooting

  • Invalid Credentials or Host: Errors may occur if the API token or host URL is incorrect or expired. Verify and update credentials accordingly.
  • Insufficient Permissions: The API token used must have permissions to access the Unity Catalog and list volumes; otherwise, authorization errors will appear.
  • Incorrect Catalog or Schema Names: Providing non-existent or misspelled catalog or schema names will result in empty results or errors. Double-check these inputs.
  • Network Issues: Connectivity problems between n8n and Databricks can cause request failures. Ensure network access and firewall rules allow communication.

Common error messages might include unauthorized access, resource not found, or bad request due to invalid parameters. Resolving them involves checking credentials, input values, and API permissions.

Links and References

Discussion