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 various Dataiku DSS resources. Specifically for the Dataset resource and the Set Schema operation, it enables users to update or set the schema of a specified dataset within a project in Dataiku DSS.

Common scenarios where this node is beneficial include:

  • Automating dataset schema updates as part of data pipeline workflows.
  • Managing dataset metadata programmatically without manual intervention in the Dataiku DSS UI.
  • Integrating schema management into larger automation or orchestration processes.

For example, you might use this node to programmatically define or modify the structure of a dataset before loading data into it, ensuring that downstream processes have consistent schema definitions.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project containing the dataset.
Dataset Name The name of the dataset whose schema you want to set or update.
Request Body A JSON object representing the new schema definition to apply to the dataset.

Output

The node outputs the response from the Dataiku DSS API after attempting to set the dataset schema. The output is provided in the json field and typically contains confirmation details or the updated schema information returned by the API.

If the operation involves downloading files (not applicable for Set Schema), the node would output binary data representing the downloaded file. For the Set Schema operation, the output is JSON only.

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.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not provided or invalid, the node will throw an error indicating missing credentials. Ensure you configure the API key credential properly.
  • Required Parameters Missing: The node validates required parameters such as Project Key and Dataset Name. If these are missing, it throws descriptive errors. Make sure all required fields are filled.
  • Invalid JSON in Request Body: The Request Body must be valid JSON representing the schema. Invalid JSON will cause the API call to fail.
  • API Errors: Any errors returned by the Dataiku DSS API (e.g., permission issues, invalid schema format) will be surfaced as node errors with messages from the API. Review the error message and verify your inputs and permissions.

Links and References


This summary focuses on the Dataset resource's Set Schema operation, describing how to use the node to update dataset schemas via the Dataiku DSS API.

Discussion