Dataiku DSSInstall

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 SQL Query resource and the Verify Query operation, the node verifies an existing SQL query by its ID through the Dataiku DSS API.

Common scenarios where this node is beneficial include:

• Validating SQL queries before execution to ensure correctness.
• Automating workflows that require confirmation of query validity.
• Integrating Dataiku DSS query verification into larger data pipelines or automation tasks.

For example, a user can input a SQL query ID to verify if the query syntax and logic are valid within the Dataiku DSS environment, helping prevent runtime errors in downstream processes.

Properties

Output

The output of the node contains a JSON object representing the response from the Dataiku DSS API after verifying the SQL query. The structure depends on the API's response but typically includes details about the verification status, any errors found, or confirmation of query validity.

If the API returns binary data (not typical for this operation), it would be provided as binary output, but for the Verify Query operation, the output is JSON.

Example output JSON might look like:

{
  "status": "success",
  "message": "Query verified successfully",
  "details": {
    // Additional verification details here
  }
}

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 Dataiku DSS server URL and user API key to be configured in the credentials.
• The node uses HTTP requests to communicate with the Dataiku DSS REST API endpoints.

Troubleshooting

• Missing Credentials Error: If the node throws an error about missing credentials, ensure that the Dataiku DSS API credentials (server URL and API key) are properly set up in n8n.
• Required Parameter Errors: The node validates required parameters such as Query ID and Project Key. Missing these will cause errors. Make sure all required fields are filled.
• API Request Failures: Network issues, incorrect server URLs, or invalid API keys can cause request failures. Verify connectivity and credentials.
• Unexpected Response Format: If the API response cannot be parsed as JSON, check if the API endpoint has changed or if there are permission issues.
• Error Messages from API: The node surfaces errors returned by the Dataiku DSS API. Review the error message for clues, such as invalid query ID or insufficient permissions.

Links and References

• Dataiku DSS API Documentation
• Dataiku DSS SQL Queries API
• n8n Documentation - Creating Custom Nodes

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