Databricks icon

Databricks

Interact with Databricks API

Overview

The node provides integration with the Databricks API, specifically allowing interaction with various Databricks resources including Unity Catalog. For the Unity Catalog - Get Volume operation, the node retrieves information about a specific volume within a given catalog and schema in the Unity Catalog service.

This operation is useful when you need to programmatically access metadata or details about storage volumes defined in your Unity Catalog environment. For example, it can be used to verify volume configurations, audit storage usage, or integrate volume data into automated workflows for data governance or analytics.

Properties

Name Meaning
Catalog The name of the catalog to query within Unity Catalog. This specifies the top-level container for schemas and volumes.
Schema The name of the schema within the specified catalog. This narrows down the scope to a particular schema where the volume resides.

Output

The output JSON contains the details of the requested volume from the Unity Catalog. This typically includes metadata such as volume identifiers, configuration settings, storage details, and possibly status information related to the volume.

If the node supports binary data output (not explicitly shown here), it would represent any associated files or binary content linked to the volume, but this is not indicated in the provided code snippet.

Dependencies

  • Requires an active Databricks API connection configured with:
    • A valid host URL for the Databricks workspace.
    • An API authentication token (API key) with permissions to access Unity Catalog resources.
  • The node depends on the n8n workflow environment and its HTTP request capabilities to communicate with the Databricks REST API.

Troubleshooting

  • Common issues:

    • Invalid or missing API token leading to authentication errors.
    • Incorrect catalog or schema names causing "not found" errors.
    • Insufficient permissions on the API token to access Unity Catalog volumes.
    • Network connectivity problems preventing API calls.
  • Error messages and resolutions:

    • 401 Unauthorized: Check that the API token is correct and has necessary scopes.
    • 404 Not Found: Verify that the catalog and schema names are spelled correctly and exist.
    • 403 Forbidden: Ensure the API token has permission to read Unity Catalog volumes.
    • Network errors: Confirm network access to the Databricks host URL.

Links and References

Discussion