Databricks icon

Databricks

Interact with Databricks API

Overview

This node integrates with the Databricks platform, specifically supporting multiple resources including Unity Catalog. The "Update Catalog" operation under the Unity Catalog resource allows users to modify or update catalog metadata within their Databricks workspace.

Typical use cases include managing data governance and organization by updating catalog information such as descriptions or other metadata fields. For example, a data engineer might automate catalog updates after schema changes or to add descriptive comments for better data discoverability.

Properties

Name Meaning
Catalog Select a Unity Catalog to work with. The list is automatically populated from your Databricks workspace.
Schema Select a schema from the chosen catalog. The list is dynamically loaded based on the selected catalog.

Output

The node outputs JSON data representing the response from the Databricks API after performing the update operation on the Unity Catalog. This typically includes confirmation of the update and any relevant metadata returned by the API.

If the node supports binary data output (not indicated for this operation), it would represent files or attachments related to the catalog update, but in this case, the output is purely JSON.

Dependencies

  • Requires an active connection to a Databricks workspace.
  • Needs an API authentication token (API key or bearer token) configured in n8n credentials to authorize requests.
  • The node relies on the Databricks REST API endpoints for Unity Catalog operations.
  • Network access to the Databricks host URL specified in credentials.

Troubleshooting

  • Common Issues:

    • Incorrect or expired API token leading to authorization errors.
    • Selecting a catalog or schema that does not exist or is inaccessible due to permissions.
    • Network connectivity problems preventing API calls.
  • Error Messages:

    • API Error: <status code> <status text>: Indicates the Databricks API returned an error. Check the status code and message for details (e.g., 401 Unauthorized means invalid credentials).
    • Network Error: No response received from server: Suggests network issues or incorrect host URL configuration.
    • Validation errors if required parameters like Catalog or Schema are missing.
  • Resolutions:

    • Verify and refresh API credentials.
    • Confirm the selected catalog and schema exist and you have access rights.
    • Ensure the Databricks host URL is correct and reachable from your environment.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully during batch executions.

Links and References

Discussion