Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, enabling users to perform a wide range of operations on various Dataiku DSS resources. Specifically for the Dataset resource and the List Tables Schemas operation, it allows users to list the schemas of tables within a SQL connection in a given project. This is useful when you want to explore or audit the database schema associated with your datasets in Dataiku DSS.

Common scenarios include:

  • Retrieving available table schemas to understand the structure of data sources.
  • Automating workflows that depend on schema metadata.
  • Integrating schema information into broader data pipelines or documentation processes.

Example: You have a project in Dataiku DSS and want to programmatically fetch all table schemas from its connected SQL databases to validate or document them.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project where the dataset resides.
Query Parameters Optional additional parameters to filter or paginate the results. Available options include: Active (boolean), Catalog Name (string), Limit (number, min 1), Page (number), Schema Name (string), and many others as per the full list provided.

The "Query Parameters" collection supports many optional filters and pagination controls to customize the request.

Output

The node outputs JSON data representing the response from the Dataiku DSS API for the requested operation.

For the List Tables Schemas operation under the Dataset resource, the output JSON will contain an array or object describing the schemas of tables available in the specified SQL connection within the project.

If the operation involves downloading files (not applicable here), the node can output binary data prepared for further use.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key credential) for authentication against 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 node throws "Missing Dataiku DSS API Credentials," ensure that the API key credential is properly set up in n8n.
  • Required Parameter Errors: The node validates required parameters such as Project Key. Missing these will cause errors like "Project Key is required."
  • API Request Failures: Network issues, incorrect URLs, or insufficient permissions may cause API call failures. Check the Dataiku DSS server accessibility and user permissions.
  • Parsing Errors: If the response cannot be parsed as JSON, the node attempts to return raw text or binary data. Ensure the API endpoint matches the expected content type.

Links and References


This summary focuses on the Dataset resource's List Tables Schemas operation, describing how the node constructs the API request, handles input properties, and returns the API response.

Discussion