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 and other resources within a Dataiku project. Specifically, for the Dataset resource and the Get Dataset Settings operation, it retrieves the settings of a specified dataset within a given project.

Use cases include:

  • Fetching configuration details of a dataset to understand its schema, partitioning, or other metadata.
  • Automating workflows that require dataset settings information for validation or further processing.
  • Integrating Dataiku dataset metadata into external systems or dashboards.

Example: You want to programmatically retrieve the settings of a dataset named "sales_data" in project "PROJ123" to verify its configuration before running data quality checks.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku project containing the dataset.
Dataset Name The name of the dataset whose settings you want to retrieve.

Output

The output is a JSON object representing the dataset settings as returned by the Dataiku DSS API. This typically includes detailed configuration information about the dataset such as schema, partitions, metadata, and other relevant settings.

If the operation involves downloading files (not applicable for this operation), binary data would be returned accordingly, but for "Get Dataset Settings," the output is purely JSON.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Needs an API key credential for authentication with the Dataiku DSS API.
  • The node expects the base URL of the Dataiku DSS server and the user API key to be configured in the credentials.

Troubleshooting

  • Missing Credentials Error: If the API key or server URL is not provided, the node will throw an error indicating missing credentials. Ensure the API key credential is properly set up.
  • Required Parameters Missing: Errors will occur if either the Project Key or Dataset Name is not provided when executing the operation. Make sure these inputs are correctly filled.
  • API Request Failures: Network issues, incorrect project or dataset names, or insufficient permissions can cause API call failures. Verify connectivity, input correctness, and user permissions.
  • Unexpected Response Format: If the API returns non-JSON or unexpected data, parsing errors may occur. Check the Dataiku DSS API version compatibility.

Links and References


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

Discussion