Explain query execution plan
POST /queries/explain
POST
/queries/explain
Get the execution plan for a SQL query without executing it.
Request Body:
tables: Map of table names (as referenced in SQL) to table IDssql: SQL query to explain
Phase 1 Constraint: All tables must belong to the same team.
Authorizations
Section titled “Authorizations ”Request Body
Section titled “Request Body ”object
tables
required
object
key
additional properties
Any of:
Dataset table ID (backwards compatible format)
string
object
tableId
required
Dataset table ID
string
filters
Optional row-level filters for this table
Array<object>
object
field
required
Column name to filter on
string
op
required
Comparison operator
string
value
Any of:
string
number
boolean
Array<string>
Array<number>
sql
required
string
Responses
Section titled “ Responses ”Execution plan retrieved
object
plan
required
string
Bad Request - Validation error or invalid input
object
error
required
string
code
string
details
retryable
boolean
Unauthorized - Authentication required or invalid token
object
error
required
string
code
string
details
retryable
boolean
Forbidden - Insufficient permissions
object
error
required
string
code
string
details
retryable
boolean
Not Found - Resource does not exist
object
error
required
string
code
string
details
retryable
boolean