Overview
This endpoint returns the pipeline structure that would be executed for a given query, allowing you to inspect the lineage and execution order before running the pipeline. This is useful for understanding dependencies and planning pipeline executions. The pipeline definition contains all the nodes (queries and materialized view refreshes) in the correct dependency order.The
query_parameters should be passed as a URL-encoded JSON string in the query parameter, where keys are parameter names and values are parameter values.Use Cases
Inspect Pipeline Before Execution
Check what queries and materialized views will be executed:Validate Dependencies with Parameters
Understand query dependencies before running a pipeline with specific parameters:Response Structure
The response contains apipeline object with a nodes array. Each node represents either a query execution or materialized view refresh, along with its dependencies.
Example response:
Best Practices
Use Before Pipeline Execution
Use Before Pipeline Execution
Call this endpoint before executing a pipeline to understand what will be executed and in what order. This helps with planning and cost estimation.
Validate Complex Dependencies
Validate Complex Dependencies
For queries with many dependencies, use this endpoint to visualize the execution graph and identify potential bottlenecks.
Test with Parameters
Test with Parameters
When using query parameters, test the pipeline structure with different parameter values to ensure the lineage is resolved correctly.
Related Endpoints
- Execute Query Pipeline - Execute a query’s pipeline
- Execute Pipeline - Execute a pipeline based on lineage
- Get Pipeline Status - Check pipeline execution status
Headers
API Key for the service
Path Parameters
Unique identifier of the query
Query Parameters
Alternative to using the X-Dune-Api-Key header
The performance engine tier. Can be either medium or large.
SQL Query parameters in json key-value pairs
Response
OK
The pipeline definition containing nodes to execute