Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, allowing users to perform a wide range of operations on Dataiku DSS resources. Specifically for the Dataset resource and the Update From Hive Metastore operation, the node updates a dataset in Dataiku DSS by synchronizing it with the corresponding table metadata from the Hive metastore. This is useful when the underlying Hive table schema or properties have changed, and you want the Dataiku dataset to reflect those changes without manually updating it.

Common scenarios include:

  • Keeping Dataiku datasets in sync with external Hive tables after schema evolution.
  • Automating dataset metadata refreshes as part of data pipeline workflows.
  • Ensuring consistency between Hive metastore definitions and Dataiku datasets for accurate downstream processing.

Example: You have a dataset in Dataiku linked to a Hive table. After adding columns or changing types in Hive, you use this node operation to update the Dataiku dataset schema accordingly.

Properties

Name Meaning
Project Key The key identifier of the Dataiku project containing the dataset.
Dataset Name The name of the dataset within the specified project to update from the Hive metastore.

Output

The output JSON contains the response from the Dataiku DSS API after performing the update operation. Typically, this will be a confirmation object indicating success or details about the updated dataset.

  • The json field includes the API response parsed as JSON.
  • No binary data output is expected for this operation.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key) for authentication with the Dataiku DSS API.
  • The node expects the Dataiku DSS server URL and user API key to be configured in the credentials.
  • The Dataiku DSS API must be accessible from the environment where n8n runs.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node throws an error "Missing Dataiku DSS API Credentials". Ensure that the API key credential is properly configured.
  • Required Parameter Errors: The node validates required parameters such as Project Key and Dataset Name. Missing these will cause errors like "Project Key is required" or "Dataset Name is required".
  • API Request Failures: Network issues, incorrect server URLs, or insufficient permissions can cause API call failures. Check connectivity and API permissions.
  • Unexpected Response Format: If the API returns non-JSON or unexpected responses, parsing errors may occur. Review the API server logs or response content.

Links and References


This summary focuses on the Dataset resource's Update From Hive Metastore operation as requested, based on static analysis of the provided source code and property definitions.

Discussion