DatabricksInstall

Overview

The node provides integration with the Databricks platform, specifically supporting multiple resources including Unity Catalog. For the Unity Catalog - Get Catalog operation, it allows users to retrieve metadata about catalogs and schemas within their Databricks workspace's Unity Catalog service.

This operation is useful when you want to programmatically access or list available catalogs and their schemas in your Databricks environment. For example, you might use this node to dynamically populate dropdowns in workflows, validate catalog/schema existence before running queries, or automate data governance tasks by fetching catalog details.

Properties

• Both properties are required.
• The "Catalog" property fetches available catalogs via a GET request to /api/2.1/unity-catalog/catalogs.
• The "Schema" property depends on the selected catalog and fetches schemas via /api/2.1/unity-catalog/schemas?catalog_name={{catalog}}.

Output

• The output JSON contains the response data from the Databricks Unity Catalog API.
• For the "Get Catalog" operation, the output will include details of the selected catalog and its schemas as returned by the API.
• The structure typically includes catalog names, comments (descriptions), and schema information.
• No binary data output is involved in this operation.

Dependencies

• Requires an active Databricks API authentication token configured in the node credentials.
• The node uses the Databricks REST API endpoints under /api/2.1/unity-catalog/ for catalog and schema retrieval.
• Network connectivity to the Databricks workspace host URL is necessary.

Troubleshooting

• Common issues:

  • Authentication failures due to invalid or expired API tokens.
  • Network errors if the Databricks host URL is unreachable.
  • Empty or missing catalog/schema lists if the user lacks permissions or if no catalogs exist.

• Error messages:

  • API Error: <status> <statusText> indicates a problem with the API request; check credentials and permissions.
  • Network Error: No response received from server suggests connectivity issues.
  • If the node fails to load catalogs or schemas, verify that the Databricks workspace has Unity Catalog enabled and that the API token has sufficient privileges.

• Resolution tips:

  • Ensure the API token is valid and has appropriate scopes.
  • Confirm the workspace URL is correct and accessible.
  • Check user permissions for Unity Catalog access in Databricks.

Links and References

• Databricks Unity Catalog API Documentation
• Databricks REST API Reference
• n8n Documentation on Credentials