Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node interacts with the Dataiku DSS API to perform various operations on datasets within a Dataiku project. Specifically, for the "Dataset" resource and the "Delete Dataset" operation, it allows users to delete an entire dataset from a specified project in Dataiku DSS.

Common scenarios where this node is beneficial include:

  • Automating the cleanup of datasets that are no longer needed.
  • Managing datasets programmatically as part of a larger data pipeline or workflow.
  • Integrating dataset deletion into CI/CD pipelines or scheduled automation tasks.

Example use case:

  • A user wants to delete a dataset named "sales_data_2023" from the project "RetailProject" after archiving its contents elsewhere. This node can be configured to perform that deletion automatically.

Properties

Name Meaning
Project Key The unique identifier (key) of the Dataiku project containing the dataset.
Dataset Name The name of the dataset to delete within the specified project.
Query Parameters Optional additional parameters as key-value pairs to customize the API request.

Output

The output of the node is a JSON array containing the response from the Dataiku DSS API after attempting to delete the dataset. The structure depends on the API's response but typically includes confirmation of deletion or error details.

If the deletion is successful, the output may be empty or contain status information. If there is an error, the output will include error messages describing the failure.

No binary data output is expected for this operation.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials: specifically, a server URL and a user API key for authentication.
  • The node expects the Dataiku DSS API to be accessible at the provided server address.
  • No additional external services are required beyond the Dataiku DSS API.

Troubleshooting

  • Missing Credentials: The node will throw an error if the API credentials (server URL and API key) are not provided or invalid.
  • Missing Required Parameters: Errors occur if the "Project Key" or "Dataset Name" is not specified when performing the delete operation.
  • API Errors: If the dataset does not exist or the user lacks permissions, the API will return an error which the node surfaces. Check that the project and dataset names are correct and that the API key has sufficient privileges.
  • Network Issues: Connectivity problems to the Dataiku DSS server will cause request failures.
  • Unexpected Response Format: If the API returns unexpected data, parsing errors might occur; ensure the API version matches expectations.

To resolve common errors:

  • Verify all required input fields are filled correctly.
  • Confirm API credentials are valid and have necessary permissions.
  • Ensure the Dataiku DSS server is reachable from the n8n environment.
  • Review API documentation for any changes in endpoint behavior.

Links and References

Discussion