Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions100

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 List Tables operation, it enables listing tables in a schema of a SQL connection within a specified project. This is useful when you want to programmatically retrieve available tables from datasets managed in Dataiku DSS, facilitating automation workflows that depend on dataset structure or metadata.

Common scenarios include:

  • Automating data pipeline steps that require knowledge of available tables.
  • Dynamically fetching table lists to drive further processing or validation.
  • Integrating Dataiku DSS dataset metadata into other systems or dashboards.

Example: You have a project in Dataiku DSS and want to list all tables available in its datasets' SQL schemas to validate or document them automatically.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project where the dataset resides.
Query Parameters Optional key-value pairs to filter or paginate the results. For example, limit, page.

The Query Parameters collection supports many optional parameters (e.g., limit, page, filter, schemaName) that can be used to refine the request. For the "List Tables" operation, relevant parameters might include:

  • limit: Max number of results to return.
  • page: Page number for paginated results.
  • schemaName: Name of the schema to list tables from.
  • Other filtering options as supported by the API.

Output

The output is a JSON array containing the list of tables retrieved from the specified project's dataset schemas. Each item in the array represents a table with its associated metadata as returned by the Dataiku DSS API.

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

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Needs valid API credentials (an API key) configured in n8n to authenticate requests.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API endpoints.

Troubleshooting

  • Missing Credentials Error: If the API key credential is not set or invalid, the node will throw an error indicating missing credentials.
  • Required Parameter Missing: The node validates required parameters such as Project Key and will throw errors if these are not provided.
  • API Request Failures: Network issues, incorrect project keys, or insufficient permissions may cause API call failures. Check the error message for details.
  • Unexpected Response Format: If the API returns unexpected data, parsing errors may occur. Ensure the Dataiku DSS API version is compatible.

Links and References


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

Discussion