analyze_query
Explain ClickHouse SELECT queries to get query execution plan, pipeline, and syntax analysis. Supports read-only statements with optional profile and database settings.
Instructions
[ClickHouse] Explain read-only SELECT or WITH … SELECT.
Returns plan, pipeline, and/or syntax text. Default types plan and pipeline. Uses query timeout and optional database; no max-rows cap unlike run_query.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"sql": "<sql>"
},
"name": "analyze_query"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sql | Yes | Read-only SELECT or WITH … SELECT for EXPLAIN. One statement; same validation as run_query. | |
| types | No | EXPLAIN variants: plan (indexes), pipeline, syntax. Default plan and pipeline if omitted. | |
| profile | No | Profile name; uses default profile when omitted. Src: profiles. | |
| database | No | Session default database for unqualified names. Src: databases. | |
| parameters | No | Named parameters for driver placeholders (e.g. %(name)s or {name:Type}). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan | No | EXPLAIN PLAN output. | |
| syntax | No | EXPLAIN SYNTAX output. | |
| pipeline | No | EXPLAIN PIPELINE output. |