Databricks icon

Databricks

Interact with Databricks API

Overview

The node provides integration with the Databricks API, specifically supporting multiple resources including Unity Catalog. For the Unity Catalog - Delete Catalog operation, it allows users to delete a specified catalog within their Databricks workspace.

This node is beneficial in scenarios where automated management of Databricks Unity Catalogs is required, such as cleaning up unused catalogs, managing data governance, or integrating catalog lifecycle management into broader workflows.

Practical example: Automatically deleting a Unity Catalog after archiving its data elsewhere, as part of a data pipeline cleanup process.


Properties

Name Meaning
Catalog Select a Unity Catalog to work with. The list is automatically populated from your Databricks workspace.

Note: Although the provided properties JSON includes both "Catalog" and "Schema", the "Delete Catalog" operation logically only requires the "Catalog" property to specify which catalog to delete. The "Schema" property is likely used for other operations.


Output

  • The output JSON contains the response from the Databricks API after attempting to delete the specified catalog.
  • Typically, this will include success confirmation or error details.
  • No binary data output is involved in this operation.

Example output structure (conceptual):

{
  "success": true,
  "message": "Catalog deleted successfully"
}

or in case of error:

{
  "error": "API Error: 404 Not Found",
  "details": {
    "message": "Catalog does not exist"
  }
}

Dependencies

  • Requires an active Databricks workspace with Unity Catalog enabled.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The node uses the Databricks REST API endpoint /api/2.1/unity-catalog/catalogs for catalog management.
  • Network connectivity to the Databricks instance is necessary.

Troubleshooting

  • Common issues:

    • Attempting to delete a catalog that does not exist or is already deleted.
    • Insufficient permissions or missing API token leading to authorization errors.
    • Network connectivity problems preventing API calls.
  • Common error messages:

    • API Error: 404 Not Found: The specified catalog was not found. Verify the catalog name.
    • API Error: 403 Forbidden: The API token lacks permission to delete catalogs. Check user roles and token scopes.
    • Network Error: No response received from server: Connectivity issues; verify network and Databricks host URL.
  • Resolutions:

    • Confirm the catalog name is correct and exists.
    • Ensure the API token has appropriate permissions for Unity Catalog management.
    • Check network settings and Databricks host configuration in credentials.

Links and References

Discussion