Databricks icon

Databricks

Interact with Databricks API

Overview

This node enables interaction with the Databricks API, specifically supporting operations on various resources including Unity Catalog. For the Unity Catalog resource, the "Get Function" operation allows users to retrieve metadata or details about a specific function within a given catalog and schema in the Unity Catalog service.

Common scenarios for this node include:

  • Retrieving information about user-defined functions or system functions stored in Unity Catalog.
  • Automating metadata management workflows by programmatically accessing function definitions.
  • Integrating Databricks Unity Catalog function data into broader data pipelines or dashboards.

Example use case: A data engineer wants to fetch details of a particular function defined in a Unity Catalog schema to verify its properties before using it in a SQL query or data transformation.

Properties

Name Meaning
Catalog The name of the catalog in Unity Catalog where the target function resides.
Schema The schema within the specified catalog that contains the function to be retrieved.

These properties are required inputs to specify the exact location of the function within Unity Catalog.

Output

The node outputs JSON data representing the details of the requested function from Unity Catalog. This typically includes metadata such as the function's name, parameters, return type, and other relevant attributes as provided by the Databricks API.

If the node supports binary data output (not indicated here), it would represent any associated binary content related to the function, but based on the provided code and properties, the output is purely JSON metadata.

Dependencies

  • Requires an active Databricks account with access to the Unity Catalog feature.
  • Needs an API authentication token configured in n8n credentials to authorize requests to the Databricks API.
  • The node uses the base URL and authorization token from the configured credentials to make API calls.

Troubleshooting

  • Missing or incorrect Catalog/Schema names: Ensure that the catalog and schema names are correctly spelled and exist in your Databricks Unity Catalog environment.
  • Authentication errors: Verify that the API token credential is valid and has sufficient permissions to access Unity Catalog resources.
  • API connectivity issues: Check network connectivity and that the Databricks host URL is correctly set in the credentials.
  • Function not found: If the function does not exist in the specified catalog and schema, the node will likely return an error or empty response. Confirm the function's existence beforehand.

Links and References

Discussion