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 Dataiku DSS resources directly from n8n workflows. Specifically for the SQL Query resource and the Stream Query operation, it streams the results of an existing SQL query execution in Dataiku DSS.

Typical use cases include:

  • Retrieving large SQL query results incrementally without waiting for the entire query to complete.
  • Integrating Dataiku DSS SQL query results into automated data pipelines or dashboards.
  • Monitoring and processing query outputs in real-time or near-real-time scenarios.

For example, a user might start a SQL query execution in Dataiku DSS using another operation, then use this Stream Query operation to fetch and process the results as they become available.

Properties

Name Meaning
Query ID The unique identifier of the SQL query whose results you want to stream.
Query Parameters Optional key-value pairs to parameterize the query execution (only applicable if supported).

Note: The provided properties JSON includes many options, but for the SQL Query - Stream Query operation, only the "Query ID" and "Query Parameters" are relevant.

Output

The node outputs the streamed results of the specified SQL query in the json field of the output items. Each item corresponds to a chunk or batch of the query result data streamed from Dataiku DSS.

If the response is binary (e.g., downloading files), the node prepares the binary data accordingly, but for streaming SQL query results, the output is JSON structured data representing rows or records returned by the query.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials for Dataiku DSS (an API key credential).
  • The node uses HTTP requests to interact with the Dataiku DSS REST API.
  • No additional external services or environment variables are required beyond the configured Dataiku DSS API credentials.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing Dataiku DSS API credentials, ensure that the API key credential is properly configured in n8n.
  • Missing Query ID: The node requires a valid Query ID to stream results. If not provided, it will throw an error.
  • HTTP Errors: Errors from the Dataiku DSS API (e.g., 404 Not Found if the query ID does not exist) will be surfaced as node errors. Verify the Query ID and permissions.
  • Timeouts or Large Result Sets: Streaming large query results may take time; ensure network stability and consider pagination or limits if supported.
  • Invalid Query Parameters: If query parameters are used, ensure they match the expected format and names defined in the Dataiku DSS query.

Links and References


This summary focuses on the SQL Query resource and the Stream Query operation as requested, based on static analysis of the provided source code and property definitions.

Discussion